Domoticz Wiki - User contributions [en]

DynamicDashboard

2026-08-11T18:32:54Z

Walter vl: /* Overview */

= Dashboard Dynamic =

<blockquote>'''Note:''' This page is maintained in the [https://github.com/domoticz/domoticz/tree/development/docs Domoticz GitHub repository]. Please do not edit it directly on the Wiki.
</blockquote>
'''Revision:''' 2026-05-11 
'''Minimum build:''' 17950

-----


== Enabling Dashboard Dynamic ==

Dashboard Dynamic is opt-in per user. To enable it, go to '''My Profile''' (top-right menu) and check '''Use Dynamic Dashboard''', then save. The '''Dashboard''' menu item will now open the dynamic dashboard instead of the classic one.

Administrators can also enable or disable it for any user via '''Setup → Users'''.

-----


== Overview ==

Dashboard Dynamic is a fully modular, drag-and-drop dashboard system for Domoticz. It replaces the fixed-layout classic dashboard with a flexible, personalized workspace where users can freely compose, resize, and arrange widgets to their liking.

Key characteristics:

* Per-user persistent layouts stored in the Domoticz database
* Multiple named dashboards per user
* Real-time device updates via the existing WebSocket (livesocket)
* Fully theme-aware using CSS custom properties (<code>--dz-*</code> variables)
* Responsive across screen sizes
[[File:Dynamic dashboard.png]]
-----


== Getting Started ==

Navigate to the '''Dashboard''' menu item. On first visit, a starter layout is created automatically containing a Clock, Sun Info, and Activity Log widget.


=== Toolbar (Compact Mode) ===

In view mode, a small floating pill bar appears in the top-right corner of the page. It contains:

* '''Dashboard name''' — click to open the switcher dropdown if multiple dashboards exist
* '''Pencil icon''' — enter Edit Mode
* '''Play icon''' — start/stop Kiosk mode (visible when 2+ dashboards exist)

The bar fades to 50% opacity when not hovered to stay out of the way.


=== Edit Mode ===

Press the pencil button or '''Ctrl+E''' to enter Edit Mode. The full toolbar appears at the top:

{| class="wikitable"
|-
! Button
! Action
|-
| ⓘ (info icon)
| Opens the Dynamic Dashboard wiki page
|-
| Dashboard title
| Click to rename inline
|-
| '''Dashboards'''
| Switch between dashboards, create a new one, or open Dashboard Settings
|-
| '''Edit'''
| Access layout actions (Set as Default, Export/Import, Duplicate, Delete, Clear)
|-
| '''Done Editing'''
| Save changes and exit edit mode
|-
| '''Add Widget'''
| Open the widget library panel
|-
| '''Save'''
| Manually save current layout
|-
| '''Cancel'''
| Discard unsaved changes (button turns red when there are unsaved changes)
|}

'''Dashboards dropdown:'''

{| class="wikitable"
|-
! Item
! Action
|-
| ''(dashboard name)''
| Switch to that dashboard (prompts to discard unsaved changes if needed)
|-
| '''New Dashboard'''
| Creates a new dashboard with an auto-generated name; rename it via the title field
|-
| '''Dashboard Settings…'''
| Open kiosk and standby settings
|}

'''Edit dropdown:'''

{| class="wikitable"
|-
! Item
! Action
|-
| '''Export / Import'''
| Open the export/import dialog
|-
| '''Reset to Favorites'''
| Populate the dashboard from your favorite devices
|-
| '''Set as Default'''
| Mark this dashboard as the default (shown with a checkmark when active)
|-
| '''Duplicate'''
| Clone the current dashboard
|-
| '''Delete'''
| Delete the current dashboard
|-
| '''Clear All Widgets'''
| Remove all widgets from the current dashboard
|}

'''Keyboard shortcuts:'''

* <code>Ctrl+E</code> — toggle edit mode
* <code>Ctrl+S</code> — save layout
* <code>Ctrl+L</code> — toggle widget library panel
* <code>Escape</code> — close widget library (if open), otherwise exit edit mode; also stops Kiosk mode


=== Widget Library ===

Click '''Add Widget''' to open the slide-in library panel on the right. Widgets are grouped by category. Use the search box to filter. Click a widget’s '''+''' button to add it to the grid.


=== Widget Actions (Edit Mode) ===

Each widget shows a header bar in edit mode with:

* '''Drag handle''' — drag the title bar to reposition
* '''Configure''' (gear icon) — open widget settings
* '''Duplicate''' (copy icon) — clone the widget; the clone starts dragging immediately
* '''Remove''' (× icon) — delete the widget

Resize any widget by dragging the bottom-right corner handle.

<blockquote>'''Note:''' All interactive elements inside widget content (buttons, links, inputs) are non-clickable in Edit Mode — only the header chrome buttons (configure, duplicate, remove) remain active. This prevents accidental device control while rearranging the layout.
</blockquote>

-----


== Managing Dashboards ==


=== Multiple Dashboards ===

Dashboard management is done directly from the Edit Mode toolbar:

{| class="wikitable"
|-
! Action
! How
|-
| '''Create'''
| Dashboards → New Dashboard (auto-names; rename inline)
|-
| '''Rename'''
| Click the dashboard title in the toolbar
|-
| '''Switch'''
| Dashboards dropdown → pick a name
|-
| '''Set as Default'''
| Edit → Set as Default
|-
| '''Duplicate'''
| Edit → Duplicate
|-
| '''Delete'''
| Edit → Delete
|-
| '''Copy deep-link'''
| Edit Mode → click the chain icon (<code>🔗</code>) next to the dashboard title
|}

'''Dashboard Settings''' (Edit → Dashboard Settings… or Dashboards → Dashboard Settings…) contains only the Kiosk and Screen Standby configuration — no layout management.


=== Deep-linking to a specific dashboard ===

You can open any dashboard directly via the URL, bypassing the normal “last viewed / default” lookup:

{| class="wikitable"
|-
! URL
! Opens
|-
| <code>#/Dashboard</code>
| Last viewed (localStorage) → default → first dashboard (existing behaviour)
|-
| <code>#/Dashboard?id=<uuid></code>
| The dashboard with the matching UUID
|-
| <code>#/Dashboard?name=<name></code>
| The dashboard whose name matches (case-insensitive) — e.g. <code>#/Dashboard?name=Smart%20Meter%20(P1)</code>
|}

'''Getting the UUID:''' in Edit Mode, click the chain icon (<code>🔗</code>) immediately to the right of the dashboard title in the toolbar. The full deep-link URL is copied to the clipboard with a toast confirmation. Paste it into a browser bookmark, a wall-tablet shortcut, a chat message, etc.

Switching dashboards through the dropdown does '''not''' update the URL — the deep-link only takes effect on page load.


=== Kiosk / Auto-Swipe Mode ===

Automatically cycles through a set of dashboards at a fixed interval — useful for wall tablets and kiosk displays.

'''Controls:'''

* '''Play/Stop button''' in the topbar (visible when 2+ dashboards exist)
* '''Escape''' key stops kiosk mode
* A thin progress bar at the bottom of the screen shows time remaining until the next switch

'''Settings''' (in Dashboard Settings → Kiosk section):

{| class="wikitable"
|-
! Setting
! Default
! Description
|-
| Enable on load
| off
| Automatically start kiosk when page loads
|-
| Interval (seconds)
| 30
| Time to display each dashboard (5–3600)
|-
| Loop
| on
| Return to first dashboard after the last
|-
| Dashboards to cycle
| all
| Check specific dashboards to include; leave all unchecked to cycle all
|}

Settings are saved in browser <code>localStorage</code> (<code>dd_kiosk</code>).


=== Screen Standby Mode ===

Dims or blanks the screen after a period of inactivity — prevents burn-in on wall-mounted displays. Any mouse movement, touch, keystroke, or click wakes the screen.

'''Settings''' (in Dashboard Settings → Screen Standby section):

{| class="wikitable"
|-
! Setting
! Default
! Description
|-
| Enable standby
| off
| Enable inactivity dimming
|-
| Inactivity timeout
| 5 min
| Minutes before screen dims (1–60)
|-
| Full blackout
| off
| Completely black screen instead of dimmed
|-
| Opacity when dimmed
| 5%
| Screen brightness when dimmed (0–30%)
|}

Settings are saved in browser <code>localStorage</code> (<code>dd_standby</code>).


=== Per-Device Dashboard Selection ===

Each browser/device independently remembers which dashboard it last viewed. When you switch dashboards on a phone, tablet, or desktop, that selection is saved in the browser’s <code>localStorage</code> — so the next time that specific device opens Domoticz, it returns to the same dashboard automatically. This means a wall tablet can always open to a “Living Room” dashboard while your phone opens to a different one, without any server-side configuration.

The active dashboard selection is stored per-origin in <code>localStorage</code> key <code>dd_active_dashboard</code>.


=== Export / Import ===

The '''Export / Import''' button opens a modal dialog with two tabs:

'''Export tab:'''

* ''Clipboard'' — generates JSON and lets you copy it to the clipboard for sharing (e.g. in forum posts)
* ''Download'' — downloads the dashboard as a <code>.json</code> file
* Choose to export the '''current dashboard''' or '''all dashboards'''

The exported JSON includes the Domoticz build revision (<code>domoticzRevision</code>) so recipients know the minimum version needed.

'''Import tab:'''

* ''Clipboard'' — paste JSON directly from the clipboard
* ''File'' — select a <code>.json</code> file from disk
* Choose to import as a '''new dashboard''' or '''replace current'''
* If the imported dashboard was created on a newer Domoticz build, a warning is shown (but import still proceeds)

-----


== Bar Indicators ==

Classic tab device widgets (Utility, Weather, Temperature) support optional color-coded bar indicators — a thin progress bar rendered below each device’s last-update timestamp. Bars provide an at-a-glance value status using configurable color ranges (e.g. green for normal values, red for high).


=== Configuring a Bar ===

# Open a device’s '''Edit''' dialog (Admin permission required) on the Utility, Weather, or Temperature tab.
# Click the '''bar chart icon''' (![bar icon]) in the top-right corner of the dialog form.
# In the '''Bar Ranges''' popup, define one or more ranges:
#* '''From / To''' — numeric bounds for this range segment
#* '''Color''' — the fill color for this segment (color picker)
#* Click '''+''' to add; drag or use the trash icon to remove
# Click '''Save''' in the popup, then '''Update''' in the Edit dialog to persist.

Ranges are stored in the device’s <code>Color</code> database field as a keyed JSON object, so each sensor type on a multi-sensor device (e.g. Temp+Hum+Baro) stores its bar configuration independently. Editing the bar from the Temperature tab configures the temperature bar; editing from the Weather tab configures the barometer bar — they do not overwrite each other.


=== Supported Device Types ===

'''Utility tab''' — all numeric sensor types: Electric usage, kWh energy, Percentage, Gas/Counter, Custom Sensor, Lux, Voltage, Current, Setpoint, Air Quality, Pressure, Distance, Weight, Sound Level, Waterflow, Fan, Leaf Wetness, Soil Moisture, A/D, Power, Energy, Current/Energy, Radiator 1.

'''Weather tab''' — all six device types: Barometer (value: pressure in hPa), Rain (value: mm), Wind (value: speed), UV (value: UVI), Visibility (value: distance), Radiation (value: from Data field).

'''Temperature tab''' — temperature sensors (value: °C/°F), humidity sensors (value: %), Temp+Humidity, Temp+Humidity+Baro, Wind+Temp/Chill.


=== Bar Display ===

Configured bars appear: - On the respective tab (Utility / Weather / Temperature) - On the classic dashboard for favorited devices (both desktop and mobile views)

The bar fills proportionally across the defined ranges and renders a linear gradient through the configured colors.

-----


== Widgets ==

Widgets are grouped into the following categories: '''Info''', '''Charts & Data''', '''Energy''', '''Devices''', '''Controls''', '''Weather''', '''Information''', '''System''', '''Custom Content'''.

-----


=== Clock ===

'''Category:''' Custom Content

Displays the current local time and date. Updates every second.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show seconds
| on
| Include seconds in the time display
|-
| 24-hour format
| on
| Use 24h clock; off for 12h with AM/PM
|-
| Show date
| on
| Show the date line below the time
|-
| Timezone
| local
| Timezone for the displayed time; search by city or region name
|-
| Show panel background
| on
| Show the widget panel background
|}

-----


=== Sun Info ===

'''Category:''' Weather

Shows today’s sunrise and sunset times, derived from the configured location in Domoticz settings.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show panel background
| on
| Show the widget panel background
|}

-----


=== Barometer ===

'''Category:''' Weather

Displays barometric pressure and weather forecast string from a barometer device.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Barometer device
| Any Temp+Baro or Temp+Hum+Baro device
|-
| Custom Title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

Live: updates on WebSocket <code>device_update</code> for the configured device.

-----


=== Weather ===

'''Category:''' Weather

Displays current weather conditions with an animated weather scene background (sun, clouds, rain, snow, moon/stars at night).

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Temperature device
| Any Temp / Temp+Hum / Temp+Hum+Baro device
|-
| Wind device
| A Wind type device
|-
| Barometer device
| A Temp+Baro or Temp+Hum+Baro device
|-
| Display style
| '''Style 1''' (default) or '''Style 2''' (see below)
|-
| Show panel background
| Show the widget panel background (default: on)
|}

'''Style 1:''' Data-dense view with the animated weather scene as a background. Shows temperature, wind speed/direction, barometer, humidity, and forecast string as individual rows.

'''Style 2:''' Full-height immersive scene card. The animated scene fills the widget (sun rays / moon + stars / clouds / rain / snow), with large temperature and forecast string centered over it. Includes dew point, humidity, and barometer. Night mode activates automatically between sunset and sunrise.

Live: updates instantly from WebSocket device updates.

-----


=== Stat Counter ===

'''Category:''' Charts & Data

Displays a single large KPI number from any device. Clicking the value navigates to the device log.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Device
| —
| Any used device
|-
| Label
| —
| Optional custom label (defaults to device name)
|-
| Show panel background
| on
| Show the widget panel background
|}

Live: updates instantly from WebSocket <code>device_update</code> events.

-----


=== Temperature Graph ===

'''Category:''' Charts & Data

Highcharts chart showing temperature history.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Temperature / Temp+Hum type device
|-
| Chart type
| See table below
|-
| Custom title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

'''Chart types:'''

{| class="wikitable"
|-
! Type
! Description
|-
| Last 24h
| Hourly temperature spline
|-
| Last 7 days
| Daily temperature spline
|-
| Last month
| Daily temperature spline
|-
| Last year
| Monthly temperature spline
|-
| Dew Point
| Temperature + dew point dual-line
|-
| Temp vs Humidity
| Temperature and humidity with dual y-axis
|-
| Comfort Zone
| Temperature/humidity scatter plot with comfort zone bands
|}

-----


=== Counter / Energy Chart ===

'''Category:''' Charts & Data

Column or area chart for counter and energy devices (kWh, Gas, Water, P1, generic counter). Automatically detects the device type and display unit.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Counter / kWh / Gas / Water / P1 Meter device
|-
| Chart type
| See table below
|-
| Custom title
| Optional override
|-
| Bar color
| Color for single-series counter charts (gas, water, non-P1 kWh). Defaults to cyan <code>#03befc</code>, matching the P1 “Usage” series. Ignored for P1 dual-series charts (which use fixed usage/return colors)
|-
| Show panel background
| Show the widget panel background (default: on)
|}

'''Chart types:'''

{| class="wikitable"
|-
! Type
! Description
|-
| Short Log
| High-resolution bars covering the last 2–3 days. For P1 meters: area chart in Watts. For all other types (water, gas, kWh): column bars in the device’s native unit. Chart title shows the actual day span (e.g. “Last 3 Days”)
|-
| Today (hourly)
| Hourly bars over the rolling last 24 hours, matching the Domoticz log page’s “Today” view
|-
| Last week
| Daily bars
|-
| Last month
| Daily bars
|-
| Last year
| Monthly bars
|-
| Compare years
| Multiple years overlaid as grouped bars per month
|}

P1 Smart Meters with return capability display import and export as two separate series.

'''Zooming:''' Drag horizontally on any chart to zoom in on a time range. A ''Reset zoom'' button appears to return to the full view.

-----


=== Wind Chart ===

'''Category:''' Charts & Data

Wind data charts for a Wind type device.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Wind type device
|-
| Chart type
| See table below
|-
| Title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

'''Chart types:'''

{| class="wikitable"
|-
! Type
! Description
|-
| Last 24h
| Speed + gust line chart. Tooltips show Beaufort scale notation (Calm, Light Breeze, Strong Breeze, etc.)
|-
| Wind Direction
| Wind rose (polar chart) showing frequency per direction sector
|-
| Speed Frequency
| Histogram of wind speed occurrences
|-
| Last Month
| Daily average speed bars
|-
| Last Year
| Monthly average speed bars
|}

-----


=== Rain Chart ===

'''Category:''' Charts & Data

Rain data charts for a Rain type device.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Rain type device
|-
| Chart type
| See table below
|-
| Title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

'''Chart types:'''

{| class="wikitable"
|-
! Type
! Description
|-
| Last 24h
| Rain rate (mm/h) line + cumulative total area, dual y-axis
|-
| Last week
| Daily total bars
|-
| Last month
| Daily total bars
|-
| Last year
| Monthly total bars
|}

-----


=== Gauge ===

'''Category:''' Charts & Data

Circular arc gauge showing the current value of any numeric device against a configurable min/max range with colour-coded thresholds.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Device
| —
| Any numeric device
|-
| Title
| device name
| Optional override
|-
| Min
| 0
| Minimum scale value
|-
| Max
| 100
| Maximum scale value
|-
| Unit
| %
| Display unit
|-
| Warn threshold
| 50
| Value where colour shifts from first to second zone
|-
| Critical threshold
| 80
| Value where colour shifts from second to third zone
|-
| Threshold mode
| low-is-good
| '''low-is-good''' (e.g. CPU load): green → yellow → red as value rises. '''high-is-good''' (e.g. battery %): red → yellow → green as value rises
|-
| Show panel background
| on
| Show the widget panel background
|}

The gauge is rendered as a pure SVG arc — no Highcharts required. The fill animates smoothly on value changes. Clicking the value or unit text navigates to the device log.

Live: refreshes every 30 seconds and on WebSocket <code>device_update</code> for the configured device.

-----


=== Custom Chart ===

'''Category:''' Charts & Data

Free-form Highcharts chart where you can combine up to 10 sensors (temperature, counter, humidity, rain, wind, etc.) on a single chart with a shared time range.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Time range
| Last 24h
| Last 24h / Last 7 days / Last month / Last year
|-
| Title
| —
| Optional chart title
|-
| Show legend
| on
| Toggle chart legend
|-
| Device 1–10
| —
| Up to 10 device pickers; each added device becomes one series
|}

The sensor type and y-axis unit are detected automatically from the device type. Series with matching units share a y-axis; incompatible units get separate axes.

-----


=== kWh Summary ===

'''Category:''' Energy

Compact stat card showing current power (W) and today’s energy total (kWh). Clicking the current power (W) value navigates to the device log.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Energy / Counter type device
|-
| Title
| Optional override (defaults to device name)
|-
| Color
| Token color: import (orange) / export (green) / solar (yellow) / gas (red)
|-
| Show panel background
| Show the widget panel background (default: on)
|}

Live: refreshes every 30 seconds and on WebSocket device updates.

-----


=== Gas Summary ===

'''Category:''' Energy

Compact stat card showing today’s gas usage and cumulative total.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Gas type device
|-
| Title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

Live: refreshes every 60 seconds and on WebSocket device updates.

-----


=== Water Summary ===

'''Category:''' Energy

Compact stat card showing today’s water usage, year-to-date total, and optionally today’s cost.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Water meter device
|-
| Title
| Optional override (defaults to device name)
|-
| Show panel background
| Show the widget panel background (default: on)
|}

Displays today’s usage (in Liters or m³ depending on device configuration), the year-to-date total derived from the annual graph, and the day’s water cost if the price is configured (price = 1000 is treated as “not configured” and hidden).

Live: refreshes every 60 seconds and on WebSocket device updates.

-----


=== P1 Electricity ===

'''Category:''' Energy

Dedicated widget for Dutch P1 smart meters showing current import/export power and today’s totals.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| P1 Electricity Meter device
|-
| Title
| Optional override
|-
| Show price
| Show today’s cost (if reported by meter)
|-
| Show panel background
| Show the widget panel background (default: on)
|}

Displays an up-arrow (exporting) or down-arrow (importing) with current watts, coloured green for export and orange for import. Sub-line shows today’s totals for both directions.

Live: refreshes every 30 seconds and on WebSocket device updates.

-----


=== Battery Status ===

'''Category:''' Energy

Battery energy storage widget showing today’s imported/exported kWh, net, and live SOC / watts / voltage. Clicking any value navigates to the corresponding device log.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Auto mode
| Read device IDs from the Energy Dashboard settings
|-
| Battery energy in
| Manual: import kWh device
|-
| Battery energy out
| Manual: export kWh device
|-
| Battery SOC
| Manual: state-of-charge % sensor
|-
| Battery watts
| Manual: current power device
|-
| Battery voltage
| Manual: voltage sensor
|-
| Title
| Optional override
|-
| Show panel background
| Show the widget panel background (default: on)
|}

When '''Auto mode''' is on, device IDs are read automatically from <code>getenergydashboarddevices</code> — zero extra configuration if the Energy Dashboard is already set up.

Live: refreshes every 60 seconds.

-----


=== Energy Dashboard ===

'''Category:''' Energy

Full energy overview widget — combines all cards (Weather, Grid, Solar, Gas, Battery) and the self-sufficiency balance bar in one resizable widget. Lifted directly from <code>forecast.html</code>. Clicking any value on a card navigates to the corresponding device log.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show weather card
| on
| Weather conditions
|-
| Show solar card
| on
| Solar power and yield
|-
| Show gas card
| on
| Gas usage
|-
| Show battery card
| on
| Battery status
|-
| Show balance bar
| on
| Self-sufficiency stats
|-
| Refresh interval
| 60s
| Seconds between data refresh
|}

Device IDs are read automatically from the Energy Dashboard settings (<code>getenergydashboarddevices</code>).

-----


=== Self-Sufficiency ===

'''Category:''' Energy

Compact bar showing energy self-sufficiency percentage and today’s balance stats (house consumption, solar yield, battery net). Device IDs are read automatically from the Energy Dashboard settings.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show gauge bar
| on
| Green→red percentage bar
|-
| Refresh interval
| 60s
| Seconds between data refresh
|}

Self-sufficiency formula:

<pre>batNet = batCharge - batDischarge
houseConsumption = p1Import + solar - p1Export - batNet
selfSufficiency = (solar + batDischarge) / houseConsumption × 100</pre>
Result is clamped to 0–100%. Battery discharge counts as local generation — energy stored earlier from solar and discharged later correctly reduces grid dependence.

-----


=== Text Sensor ===

'''Category:''' Devices

Displays the text value (<code>Data</code> field) of a Domoticz Text sensor device.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Device
| —
| Text sensor device
|-
| Show title
| on
| Show device name as header
|-
| Font size
| 14px
| Text size in pixels
|-
| Refresh interval
| 60s
| Seconds between refresh
|-
| Show panel background
| on
| Show the widget panel background
|}

Content preserves whitespace and line breaks. Live: re-fetches immediately on WebSocket <code>device_update</code> for the configured device.

-----


=== Device ===

'''Category:''' Devices

Embeds any single Domoticz device using its native widget (the same widget used in the classic dashboard).

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Device
| Any device
|}

The background is transparent in view mode. Live: instant WebSocket updates.

-----


=== Scene / Group ===

'''Category:''' Devices

Embeds a Domoticz scene or group with its native widget.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Scene or Group
| Any defined scene or group
|}

Live: WebSocket <code>scene_update</code> events.

-----


=== Favorites ===

'''Category:''' Devices

Shows all favorite devices grouped by category, reproducing the classic dashboard tabs in a single widget.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Category filter
| All / Switches & Lights / Temperature / Weather / Utility
|-
| Limit to room/plan
| Optional plan ID
|-
| Show category tabs
| Toggle tab bar
|-
| Custom Title
| Optional override
|}

Live: WebSocket <code>device_update</code> / <code>scene_update</code> + 60s polling fallback.

-----


=== Room / Plan ===

'''Category:''' Devices

Shows all devices belonging to a specific Domoticz plan (room), including scenes and groups. Supports two display modes selectable in settings.

'''Grid mode (default):''' Each device is rendered using its native widget tile — the same tiles used in the classic dashboard.

'''List mode:''' Displays all devices as a compact vertical list. Interactive device types are fully controllable:

{| class="wikitable"
|-
! Type
! Behaviour
|-
| Switch / Scene
| Toggle button; icon tinted accent when device is On. Clicking the icon navigates to the device log
|-
| Dimmer
| Label + slider icon + power toggle. Slider icon opens inline dim slider; power icon toggles On/Off. Clicking the icon navigates to the device log
|-
| Selector switch
| Shows current level; click opens inline level picker. Clicking the icon navigates to the device log
|-
| Blind
| Up / Close buttons, plus Stop if the device supports it. Clicking the icon navigates to the device log
|-
| Group
| On and Off buttons as a compact pair. Clicking the icon navigates to the device log
|-
| Security Panel
| Disarm / Arm Home / Arm Away buttons. Clicking the icon navigates to the device log
|-
| Sensor / Utility
| Read-only row: icon, device name, current value and unit. Clicking the icon navigates to the device log. P1 smart meters show two lines: usage + actual power on the first line, return energy on the second
|}

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Room / Plan
| Select the Domoticz plan to display
|-
| List layout
| Toggle between grid (default) and list mode
|-
| Custom Title
| Optional override
|}

Live: WebSocket <code>device_update</code> / <code>scene_update</code> + 60s polling fallback.

-----


=== Setpoint ===

'''Category:''' Controls

Display and control a Domoticz setpoint device with +/− step buttons and a click-to-edit popup.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Device
| —
| Setpoint type device
|-
| Title
| device name
| Optional override
|-
| Show panel background
| on
| Show the widget panel background
|}

Step, min, max, and unit are read automatically from the device. Clicking the value opens a number input popup (pre-filled with current value) for direct entry. Commands use <code>setdevice&idx=X&setpoint=Y</code>. Live: WebSocket device updates re-fetch the current value.

-----


=== Thermostat ===

'''Category:''' Controls

Combined widget showing current temperature from a sensor alongside setpoint controls. Ideal for room thermostats.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Temperature sensor
| —
| Temp / Temp+Hum sensor
|-
| Setpoint device
| —
| Setpoint device
|-
| Title
| —
| Optional override
|-
| Show panel background
| on
| Show the widget panel background
|}

Step, min, max, and unit are read automatically from the setpoint device. Displays the current temperature large and prominent, with +/− setpoint controls below. Both devices are fetched in a single API call.

-----


=== Thermostat6 ===

'''Category:''' Controls

Widget for the Thermostat6 device type. Displays all available measured values (Temp, Humidity + status, Barometer) and setpoint controls. Only rows for values present on the device are shown.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Device
| —
| Thermostat6 device
|-
| Title
| device name
| Optional override
|-
| Show panel background
| on
| Show the widget panel background
|}

Step, min, and max are read automatically from the device.

-----


=== Weather Forecast ===

'''Category:''' Weather

Multi-day weather forecast using the [https://open-meteo.com Open-Meteo API] (free, no API key required). Location is read automatically from Domoticz settings.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Days
| 7
| Forecast days to display (1–14)
|-
| Show wind
| on
| Wind speed row
|-
| Show precipitation
| on
| Precipitation row
|-
| Title
| Weather Forecast
| Optional override
|-
| Show panel background
| on
| Show the widget panel background
|}

Displays a horizontal grid of day columns, each with a weather icon (mapped from WMO weather codes), temperature range, precipitation (mm), and wind speed (km/h).

Data is cached for 30 minutes to avoid excessive API calls.

-----


=== RSS Feed ===

'''Category:''' Information

Displays items from any RSS or Atom feed.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Feed URL
| —
| Full URL of the RSS/Atom feed
|-
| Max items
| 5
| Items to display (1–20)
|-
| Refresh interval
| 300s
| Seconds between fetches
|-
| Show images
| on
| Show thumbnail images
|-
| Show date
| on
| Show relative timestamp
|-
| Open in new tab
| on
| Links open in a new browser tab
|-
| Title
| feed title
| Optional override
|}

Fetches feeds via the [https://api.rss2json.com rss2json.com] proxy (free tier, no API key needed) which solves CORS limitations.

'''Single item mode''' (<code>Max items: 1</code>): Shows the latest item with a large image, headline, and excerpt.

'''Multi-item mode''': Shows a scrollable list with thumbnails, truncated titles, and relative timestamps (“2h ago”, “3d ago”). Each item has a link icon to open the original article.

-----


=== Google Calendar ===

'''Category:''' Information

Displays upcoming events from a Google Calendar or any ICS-compatible calendar, grouped as Today / Tomorrow / upcoming days.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Calendar URL
| —
| Public ICS URL or Google Calendar API endpoint
|-
| Max events
| 7
| Maximum upcoming events to show
|-
| Show time
| on
| Show event start time
|-
| Refresh interval
| 900s
| Seconds between fetches (minimum 60)
|-
| Title
| Calendar
| Optional override
|-
| Show panel background
| on
| Show the widget panel background
|}

'''Getting a Google Calendar ICS URL:''' In Google Calendar → Settings → click the calendar → ''Integrate calendar'' → copy the '''Secret address in iCal format''' (ends in <code>.ics</code>).

'''Using the Google Calendar JSON API:''' Requires a public calendar and a Google API key:

<pre>https://www.googleapis.com/calendar/v3/calendars/{calendarId}/events
?key={apiKey}&orderBy=startTime&singleEvents=true&timeMin={now}</pre>
The widget auto-detects <code>.ics</code> vs JSON API URLs.

'''CORS handling:''' The widget fetches calendar data using a fallback chain:

# Direct request (works for CORS-friendly URLs)
# Domoticz server-side proxy (<code>json.htm?type=command&param=fetchurl&url=<encoded></code>) — avoids CORS entirely for any URL reachable from the Domoticz server
# Public CORS proxies (corsproxy.io / codetabs) as last resort

A helpful error message is shown if all methods fail.

Past events today are shown in muted color. All-day events display without a time.

-----


=== System Log ===

'''Category:''' System

Displays recent Domoticz system log entries with filter toggles.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Max entries
| 50
| Log lines to display
|-
| Show Normal
| on
| Show Normal (white) entries
|-
| Show Status
| on
| Show Status (blue) entries
|-
| Show Error
| on
| Show Error (red) entries
|-
| Auto-refresh
| 10s
| Seconds between refresh (0 = off)
|-
| Title
| System Log
| Optional override
|}

Toggle buttons in the widget header show the count per level (e.g. <code>N 42</code>, <code>S 8</code>, <code>E 2</code>) and can be clicked to show/hide each level. The Error button is coloured red when errors are present. A refresh button is also available.

-----


=== Moon Phase ===

'''Category:''' Information

Shows the current moon phase with a large emoji graphic, phase name, illumination percentage, and next full/new moon date. Calculated entirely in JavaScript — no external API required.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show phase name
| on
| Display phase label (e.g. “Waxing Gibbous”)
|-
| Show next event
| on
| Next full moon or new moon date
|-
| Show illumination
| on
| Illumination percentage
|-
| Title
| Moon
| Optional override
|}

Phase names: New Moon 🌑, Waxing Crescent 🌒, First Quarter 🌓, Waxing Gibbous 🌔, Full Moon 🌕, Waning Gibbous 🌖, Last Quarter 🌗, Waning Crescent 🌘.

Updates daily.

-----


=== Quick Actions ===

'''Category:''' Custom Content

One-click buttons to trigger scenes and control switch devices, displayed in a grid or list layout.

'''Supported device types:'''

{| class="wikitable"
|-
! Type
! Behaviour
|-
| Switch
| Toggle button; icon tinted when device is On
|-
| Push On / Push Off
| Dedicated On or Off button; no toggle, no state indicator
|-
| Dimmer
| Label + slider icon + power toggle. Click the slider icon to open an inline horizontal dim slider; drag to set level. Click the power button to toggle On/Off. Icon tinted when device is On
|-
| Selector switch
| Shows current level text; click opens an inline level picker
|-
| Blind
| Up / Close buttons, plus optional Stop button (shown automatically when the device supports it)
|-
| Group
| On and Off buttons shown as a compact pair
|-
| Scene
| One-click activate button
|-
| Security Panel
| Navigates to the Domoticz security panel page. Current arm status shown on the right; icon tinted when armed
|}

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| List layout
| off
| Display actions as a vertical list (label left, icon/status right) instead of a grid
|-
| Show panel background
| on
| Show the widget panel background
|}

'''Action list editor:'''

Use the action list to add, reorder, and remove actions. Drag the grip handle (⠿) to reorder. Click the pencil icon to rename; click the trash icon to delete.

To add an action:

# Select '''Device''' or '''Scene''' from the type dropdown
# Pick the device or scene from the searchable picker (only switch-type devices are shown)
# For '''selector switches''': the level is ''not'' chosen here — it is selected at click-time in the widget
# Optionally enter a custom label (auto-filled from device/scene name if blank)
# Click '''+''' to add

'''In the widget:'''

* Click a switch button to toggle it; the icon turns accent-coloured when the device is On
* Click a dimmer’s slider icon to reveal the inline horizontal slider; drag to set dim level; click anywhere outside to dismiss without sending a command
* Click a selector button to open the inline level picker; the current level is shown beneath the label; the active level is highlighted
* Blind Up/Stop/Close buttons are shown as a compact group with the label on the left
* Group On/Off buttons are shown as a compact pair with the label on the left
* Click a Security Panel button to open the security panel page; the current arm status is shown to the right of the label

-----


=== Quick Stat ===

'''Category:''' Custom Content

Compact status panel showing current values for any mix of devices — temperature, switches, kWh meters, humidity, and more. Useful as a at-a-glance status overview.

Each row shows an icon, device name (or custom label), current value, and unit. Switch/light states are highlighted in accent colour when On. Clicking the icon navigates to the device log.

'''Display modes:'''

* '''Grid mode (default):''' Devices shown as small cards in a responsive grid (auto-fill, min 110px)
* '''List mode:''' Devices shown as full-width rows — icon left, name, value + unit right

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| List layout
| off
| Display as vertical list instead of a grid
|-
| Show panel background
| on
| Show the widget panel background
|-
| Devices
| —
| Add any mix of devices using the device list editor. Drag the grip handle to reorder; pencil to rename; trash to remove
|}

Live: updates instantly from WebSocket <code>device_update</code> events for all configured devices.

-----


=== Text Note ===

'''Category:''' Custom Content

Displays custom text with configurable appearance. Useful for section headers, labels, or status messages. The content is rendered as sanitized HTML (DOMPurify with a strict allow-list), so a safe subset of inline markup — <code></code>, <code></code>, <code></code>, <code><div></code>, <code><a></code>, basic tables, headings, lists, and scoped <code><style></code> blocks — works for icons, color highlights, and small layouts. Scripts, iframes, and event handlers are stripped. An optional divider line can be shown alongside the text, making it easy to create visual section separators.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Content
| —
| The text or sanitized HTML to display
|-
| Font
| Default (theme)
| Default (theme), Arial, Verdana, Tahoma, Trebuchet MS, Helvetica Neue, Georgia, Times New Roman, Palatino, Courier New, Lucida Console, Impact, System UI
|-
| Size
| 14 px
| Font size in pixels (8–72)
|-
| Horizontal align
| Center
| Left / Center / Right
|-
| Vertical align
| Middle
| Top / Middle / Bottom — independent of horizontal alignment; the divider follows the chosen side
|-
| Style
| Normal
| Normal / Bold / Italic / Bold + Italic / Underline
|-
| Text color
| rgba(255,255,255,1)
| Color + opacity picker
|-
| Background color
| rgba(0,0,0,0)
| Color + opacity picker (default: transparent)
|-
| Show divider line
| off
| Show a horizontal line alongside the text
|-
| Divider color
| Accent color
| Color + opacity picker; leave empty to use the theme accent color
|}

-----


=== HTML Widget ===

'''Category:''' Custom Content

Renders arbitrary HTML inside a sandboxed <code><iframe></code>. Full documents (<code><html>…</html></code>) and plain snippets are both supported.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Widget Title
| —
| Optional label overlaid at the top of the widget
|-
| HTML Content
| —
| Full HTML document or a snippet
|-
| Allow backend API access
| off
| Adds <code>allow-same-origin</code> to the sandbox, enabling scripts to call <code>json.htm</code> and other Domoticz API endpoints
|}

'''Security:''' By default the iframe runs with <code>sandbox="allow-scripts"</code> — scripts execute in isolation and cannot access cookies, localStorage, or the parent page. Enabling '''Allow backend API access''' lifts the origin restriction so scripts can make authenticated requests to the Domoticz backend. Only enable this for HTML you wrote yourself.

-----


=== Camera Feed ===

'''Category:''' Controls

Shows a live snapshot image from a Domoticz-configured camera.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Camera
| —
| Pick from configured cameras
|-
| Refresh interval
| 5s
| Seconds between snapshot refreshes
|-
| Show camera name
| on
| Display the camera name in the widget header
|}

-----


=== Remote Image ===

'''Category:''' Custom Content

Displays a remote image from a URL, with optional auto-refresh.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Image URL
| —
| Full URL to the image
|-
| Caption
| —
| Optional label shown over the image
|-
| Fit
| Contain
| Contain (full image visible) / Cover (fill area, crop) / Stretch to fill
|-
| Refresh interval
| 0
| Seconds between reloads; 0 = no auto-refresh
|-
| Show panel background
| on
| Show the widget panel background
|}

-----


=== Website Embed ===

'''Category:''' Custom Content

Embeds any external website or web app in an iframe.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| URL
| —
| The page to embed (https:// recommended)
|-
| Title
| —
| Optional widget header label
|-
| Allow scripts
| off
| Enable JavaScript in the embedded page (trusted sources only)
|-
| Auto-reload
| 0
| Seconds between iframe reloads; 0 = off
|}

Note: Many external sites block iframe embedding via <code>X-Frame-Options</code>. Works best with local network pages.

-----


=== Battery Monitor ===

'''Category:''' System

Shows all Domoticz devices whose battery level is at or below a configurable threshold — a maintenance overview so you know which sensors need fresh batteries.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Threshold
| 25%
| Show devices at or below this battery level
|-
| Show all
| off
| When on, shows every device with a battery (above threshold shown in muted style)
|-
| Sort by
| level
| Sort by battery level ascending, or by device name
|-
| Refresh interval
| 300s
| Seconds between refresh (5 minutes)
|-
| Title
| Battery Monitor
| Optional override
|}

Battery level colours: ≤10% red, ≤25% orange, ≤50% yellow, >50% green. When nothing is below the threshold, a green “All batteries OK” message is shown. Devices without a battery (level = 255 in Domoticz) are always excluded.

-----


=== Timeout Monitor ===

'''Category:''' System

Shows all Domoticz devices that have not reported within their expected timeout interval — a quick way to spot sensors that have gone silent or lost power.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Title
| ''(empty)''
| Optional title override
|-
| Sort by
| Last update
| Sort by last update time (oldest first) or device name (A–Z)
|-
| Refresh interval
| 300s
| Seconds between refresh
|}

When no devices are timed out, nothing is shown in the list. The device list shows each device name and how long ago it last reported (e.g. “3h ago”).

-----


=== kWh Top Consumers ===

'''Category:''' System

Lists kWh-metered devices ranked by today’s energy consumption, highest first. Useful for spotting which appliances are using the most energy on any given day.

Each row shows the device name, current power draw (W), and today’s total (kWh). The list updates instantly via WebSocket when any tracked device reports — including devices currently off-screen due to the row limit, which may move up the ranking in real time.

'''Excluded automatically:''' - Devices from P1 Smart Meter hardware (L1/L2/L3 phase sensors, both serial and LAN variants) - Devices configured as type '''Return / Energy Generated''' (e.g. solar export meters) - Devices that have timed out

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Title
| ''(empty)''
| Optional title override
|-
| Max devices to show
| 20
| Maximum number of rows displayed
|-
| Exclude device IDX
| ''(empty)''
| Semicolon-separated list of device IDX values to hide (e.g. <code>42;107</code>)
|-
| Refresh interval
| 300s
| Seconds between full refresh from the backend
|-
| Show panel background
| on
| Show the widget panel background
|}

-----


=== Activity Log ===

'''Category:''' System

Shows the most recently updated devices, ordered by last update time.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Description
|-
| Max items
| 5–50 items (default 15)
|}

Live: reloads on every WebSocket device update and polls every 15 seconds.

-----


=== System Status ===

'''Category:''' System

Shows Domoticz version, build number, and hardware count.

'''Configuration:'''

{| class="wikitable"
|-
! Field
! Default
! Description
|-
| Show panel background
| on
| Show the widget panel background
|}

-----


== Live Update Reference ==

{| class="wikitable"
|-
! Widget
! Update method
|-
| Clock
| 1-second interval
|-
| Device / Scene
| Instant — WebSocket
|-
| Stat Counter
| Instant — WebSocket (no HTTP)
|-
| Weather
| Instant — WebSocket per sensor
|-
| Barometer
| Instant — WebSocket
|-
| Activity Log
| Instant — WebSocket
|-
| Favorites / Room
| Instant — WebSocket + 60s fallback
|-
| Temperature Graph
| 60s debounced reload on device update
|-
| Counter/Energy Chart
| 60s debounced reload on device update
|-
| Wind / Rain Chart
| 60s debounced reload
|-
| kWh Summary
| 30s interval + instant WebSocket
|-
| P1 Electricity
| 30s interval + instant WebSocket
|-
| Gas Summary
| 60s interval + instant WebSocket
|-
| Water Summary
| 60s interval + instant WebSocket
|-
| Battery Status
| 60s interval
|-
| Energy Dashboard
| 60s interval
|-
| Self-Sufficiency
| Configurable interval (default 60s)
|-
| Text Sensor
| Configurable interval + instant WebSocket
|-
| Setpoint / Thermostat
| 30s interval + WebSocket
|-
| Thermostat6
| 30s interval + WebSocket
|-
| System Log
| Configurable interval (default 10s)
|-
| Weather Forecast
| 30-minute interval (cached)
|-
| RSS Feed
| Configurable interval (default 5 min)
|-
| Google Calendar
| Configurable interval (default 15 min)
|-
| Moon Phase
| Daily
|-
| Gauge
| 30s interval + instant WebSocket
|-
| Battery Monitor
| Configurable interval (default 5 min)
|-
| Timeout Monitor
| Configurable interval (default 5 min)
|-
| kWh Top Consumers
| Configurable interval (default 5 min) + instant WebSocket per tracked device
|-
| Custom Chart
| 60s debounced reload on config/range change
|-
| Quick Stat
| Instant — WebSocket per device
|-
| Sun Info / Text Note / HTML / Image
| Static
|-
| Website Embed
| Configurable auto-reload interval (default off)
|-
| Camera Feed
| Configurable interval (default 5s)
|}

-----

File:Dynamic dashboard.png

2026-08-11T18:32:07Z

Walter vl:

Dynamic dashboard

DzVents: next generation Lua scripting

2026-08-09T12:38:32Z

Walter vl: /* Thermostat 6 3.1.11 */ Layout

'''Note''': This document is maintained on [https://github.com/domoticz/domoticz/blob/development/dzVents/documentation/README.md github], and the wiki version is automatically generated. Edits should be performed on github, or they may be suggested on the wiki article’s [https://wiki.domoticz.com/Talk:DzVents:_next_generation_Lua_scripting Discussion page]. Editing can be done by any editor but if you are looking for a specialized markDown editor; [https://stackedit.io/app# stackedit.io] would be a good choice.


= About dzVents =

dzVents /diː ziː vɛnts/, short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts. And … '''it is 100% Lua'''! So if you already have a bunch of event scripts for Domoticz, upgrading should be fairly easy.

Let’s start with an example. Say you have a switch that when activated, it should activate another switch but only if the room temperature is above a certain level. And when done, it should send a notification. This is how it looks in dzVents:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'Room switch'}
},

execute = function(domoticz, roomSwitch)
if (roomSwitch.active and domoticz.devices('Living room').temperature > 18) then
domoticz.devices('Another switch').switchOn()
domoticz.notify('This rocks!',
'Turns out that it is getting warm here',
domoticz.PRIORITY_LOW)
end

}</syntaxhighlight>
Or you have a timer script that should be executed every 10 minutes, but only on weekdays, and have it do something with some user variables and only during daytime:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
--activate my scene
domoticz.scenes('Evening lights').switchOn()
if (domoticz.devices('My PIR').lastUpdate.minutesAgo > 5) then
domoticz.devices('Bathroom lights').switchOff()
end
end
end
}</syntaxhighlight>
Or you want to detect a humidity rise within the past 5 minutes:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'every 5 minutes'}
},
data =
{
previousHumidity = { initial = 100 }
},
execute = function(domoticz)
local bathroomSensor = domoticz.devices('BathroomSensor')
if (bathroomSensor.humidity - domoticz.data.previousHumidity) >= 5 then
-- there was a significant rise
domoticz.devices('Ventilator').switchOn()
end
-- store current value for next cycle
domoticz.data.previousHumidity = bathroomSensor.humidity
end
}</syntaxhighlight>
Just to give you an idea! Everything in your Domoticz system is now logically available in the domoticz object structure. With this domoticz object, you can get to all the information in your system and manipulate your devices.


= Using dzVents with Domoticz =

In Domoticz go to '''Setup > Settings > Other''' and in the section EventSystem make sure the check-box ‘dzVents disabled’ is not checked. Also make sure that in the Security section in the settings '''(Setup > Settings > System > Local Networks (no username/password)''' you allow 127.0.0.1 (and / or ::1 when using IPv6 ) to not need a password. dzVents does use this port to get the location settings and to send certain commands to Domoticz. Finally make sure you have set your current location in '''Setup > Settings > System > Location''', otherwise there is no way to determine nighttime/daytime state.

There are two ways of creating dzVents event scripts in Domoticz:

# By creating scripts in your domoticz instance on your domoticz server: <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Make sure that each script has the extension <code>.lua</code> and follows the guidelines as described below.
# By creating scripts inside Domoticz using the internal Domoticz event editor: Go to '''Setup > More Options > Events'''. Press the + button and choose dzVents. You must then choose a template. They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

'''Note: scripts that you write on the file-system and inside Domoticz using the internal web-editor all share the same name-space. That means that if you have two scripts with the same name, only the one of the file-system will be used. The log will tell you when this happens.'''

'''Note: Scripts created in the internal editor are stored in the domoticz database and are all written to <code>/path/to/domoticz/scripts/dzVents/generated_scripts</code> on every domoticz restart and every “EventSystem: reset all events…”. Scripts in <code>/path/to/domoticz/scripts/dzVents/scripts</code> are not stored in the database and should be backed-up separately. '''


== Quickstart ==

If you made sure that dzVents system is active, we can do a quick test if everything works:

* Pick a switch in your Domoticz system. Write down the exact name of the switch. If you don’t have a switch then you can create a Dummy switch and use that one.
* Create a new file in the <code>/path/to/domoticz/scripts/dzVents/scripts/</code> folder (or using the web-editor in Domoticz, switch to dzVents mode first.). Call the file <code>test.lua</code>. ''Note: when you create a script in the web-editor you do '''not''' add the .lua extension!'' Also, valid script names follow the same rules as [https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words filesystem names].
* Open <code>test.lua</code> in an editor and fill it with this code and change <code><exact name of the switch></code> with the .. you guessed it… exact name of the switch device:

<syntaxhighlight lang="lua"> return {
on = {
devices = {
'<exact name of the switch>'
}
},
execute = function(domoticz, switch)
if (switch.state == 'On') then
domoticz.log('Hey! I am on!')
else
domoticz.log('Hey! I am off!')
end
end
}</syntaxhighlight>
* Save the script
* Open the Domoticz log in the browser
* In Domoticz GUI perhaps in another browser tab) press the switch.
* You can watch the log in Domoticz and it should show you that indeed it triggered your script and you should see the log messages.

See the examples folder <code>/path/to/domoticz/scripts/dzVents/examples</code> for more examples. This folder includes templates you can use to get started as well. And, if you use the GUI web editor to write your script, you will find boilerplate examples in the drop-down below the script type setting.


= Writing scripts =

In order for your scripts to work with dzVents, they have to be turned into a Lua module with a specific structure. Basically you make sure it returns a Lua table (object) with predefined keys like <code>on</code> and <code>execute</code>. Here is an example:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'My switch' }
},

execute = function(domoticz, switch)
-- your script logic goes here, something like this:
if (switch.state == 'On') then
domoticz.log('I am on!', domoticz.LOG_INFO)
end
end
}</syntaxhighlight>
Simply said, the <code>on</code>-part defines the trigger and the <code>execute</code> part is what should be done if the trigger matches with the current Domoticz event. So all your logic is inside the <code>execute</code> function.


== Sections in the script ==

Each dzVents event script has this structure:

<syntaxhighlight lang="lua">return
{
active = true, -- optional
on =
{
-- at least one of these:
customEvents = { ... },
devices = { ... },
groups = { ... },
httpResponses = { ... },
scenes = { ... },
security = { ... },
shellCommandResponses = { ... },
system = { ... },
timer = { ... },
variables = { ... },

},
data = { ... }, -- optional
logging = { ... }, -- optional
execute = function(domoticz, item, triggerInfo)
-- your code here
end
}</syntaxhighlight>

=== active = true/false (optional) ===

If <code>active = false</code>, then the script is not activated: ''dzVents will ignore the script completely''. If you don’t have <code>active</code> specified, <code>true</code> is assumed (default value). If you write scripts with Domoticz’ internal script editor then you don’t need this part as the editor has its own way of enabling and disabling scripts.

So, <code>active</code> can either be:

* '''true''': (default) the script file will be processed.
* '''false''': the script file is ignored.
* '''function(domoticz) … end''': A function returning <code>true</code> or <code>false</code>. The function will receive the domoticz object with all the information about your domoticz instance: <code>active = function(domoticz) .... end</code>. For example you could check for a Domoticz variable or switch and prevent the script from being executed. '''However, be aware that for ''every script'' in your scripts folder, this active function will be called, every cycle!! Therefore, it is better to put all your logic in the execute function instead of in the active function.'''


=== on = { … } ===

The <code>on</code> section tells dzVents ''when'' the execute function has to be executed. It holds all the events/'''triggers''' that are monitored by dzVents. If any of the events or triggers match with the current event coming from Domoticz, then the <code>execute</code> part of the script is executed by dzVents. The <code>on</code> section has many kinds of subsections that ''can all be used simultaneously'' :


==== customEvents = { … } 3.0.0 ====

A list of one or more custom event triggers. This eventTrigger can be activate by a json/api call, a MQTT message (when domoticz is setup to listen to such messages on the hardware tab) or by the dzVents internal command domoticz.emitEvent - The name of the custom-event - The name of the custom-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|See time trigger rules]].


===== API =====

<pre>- curl: curl -d "{ 'a':10, 'b':20, 'some':'text', 'sub' : { 'x':10, 'y':20 } }" "http://<domoticzIP:domoticz port>/json.htm?type=command&param=customevent&event=<myCustomEvent>"
- JSON: **< domoticzIP : domoticz port >**/json.htm?type=command&param=customevent&event=<MyEvent>&data=myData
- MQTT simple: {"command":"customevent", "event":"MyEvent","data":"myData"}
- MQTT complex: {"command":"customevent","event":"MyEvent","data":"{\"idx\":29,\"test\":\"ok\"}" }
- emitEvent: domoticz.emitEvent('myCustomEvent' [,])
`domoticz.emitEvent('myEvent') -- no data`
`domoticz.emitEvent('another event', 'some data')`
`domoticz.emitEvent('hugeEvent', { a = 10, b = 20, some = 'text', sub = { x = 10, y = 20 } })`</pre>

===== Attributes =====

The customEvent object (second parameter in your execute function) has these attributes:

* '''data''': Raw customEvent data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''.3.0.3 true when the customEvent data is a valid json string. The data is then automatically converted to a Lua table.
* '''isXML''': ''Boolean''. 3.0.3 true when the customEvent data is a valid xml string. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. 3.0.3 When the customEvent data is a valid json string, the response data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a table for quick and easy access. nil otherwise
* '''trigger''', '''customEvent''': ''String''.3.0.3 The string that triggered this customEvent instance. This is useful if you have a script that can be triggered by multiple different customEvent strings.
* '''xml'''. ''Table''. 3.0.3 When the response data is a valid xml string, the customEvent data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


==== devices = { … } ====

A list of device-names or indexes. If a device in your system was updated (e.g. a switch was triggered or a new temperature was received) and it is listed in this section then the execute function is executed. '''Note''': update does not necessarily means the device state or value has changed. Each device can be:

* The name of your device between string quotes. '''You can use the asterisk (*) wild-card here e.g. <code>PIR_*</code> or <code>*_PIR</code>'''. E.g.: <code>devices = { 'myDevice', 'anotherDevice', 123, 'pir*' }</code>
* The index (idx) of your device (as the name may change, the index will usually stay the same, the index can be found in the devices section in Domoticz). '''Note that idx is a number;'''
* The name or idx of your device followed by a time constraint, such as: <code>['myDevice'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if <code>myDevice</code> was changed, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].


==== groups = { …} ====

A list of one or more group-names or indexes. The same rules as devices apply.


==== httpResponses = { …} ====

A list of one or more http callback triggers. Use this in conjunction with <code>domoticz.openURL()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


==== shellCommandResponses = { …} 3.1.0 ====

A list of one or more scriptcommand callback triggers. Use this in conjunction with <code>domoticz.executeShellCommand()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.


==== scenes = { … } ====

A list of one or more scene-names or indexes. The same rules as devices apply. So if your scene is listed in this table then the executed function will be triggered, e.g.: <code>on = { scenes = { 'myScene', 'anotherScene' } },</code>.


==== security = { … } ====

A list of one or more of these security states:

* <code>domoticz.SECURITY_ARMEDAWAY</code>,
* <code>domoticz.SECURITY_ARMEDHOME</code>,
* <code>domoticz.SECURITY_DISARMED</code>

If the security state in Domoticz changes and it matches with any of the states listed here, the script will be executed. See <code>/path/to/domoticz/scripts/dzVents/examples/templates/security.lua</code> for an example see [[#Security_Panel|Security Panel]] for information about how to create a security panel device.


==== system = { …} 3.0.0 ====

A list of one or more system triggers.

* <code>stop</code>, <code>start</code>, <code>manualBackupFinished</code>, <code>dailyBackupFinished</code>, <code>hourlyBackupFinished</code>, <code>monthlyBackupFinished</code>, <code>resetAllDeviceStatus</code>, 3.1.5 <code>resetAllEvents</code>, 3.1.5
* The name of the system-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].
** '''start''' - fired when Domoticz has started.
** '''stop''' - fired when Domoticz is shutting down. As you probably can imagine you have only a limited amount of time - also depending on the load on your system - to have Domoticz do stuff when your script has been completed. Some commands will probably not be executed. Just give it a try.
** '''Backups''' - the trigger item (2nd parameter of the execute function) is a table that holds information about the newly created backup (location, duration in seconds and type). You could use this information to copy the file to some other location or for another purpose.
*** '''dailyBackupFinished''' - automatic backup when set in domoticz
*** '''hourlyBackupFinished''' - ” ”
*** '''monthlyBackupFinished''' - ” ”
*** '''manualBackupFinished''' - fired when you start a backup using the Domoticz GUI or via '''< domoticz IP:domoticz port >'''/backupdatabase.php
*** '''resetAllDeviceStatus''' 3.1.5- fired when the name, description or used / unused state of a device, variable or scene is updated.
*** '''resetAllEvents''' 3.1.5- fired when a dzVents script in the internal editor changed.


==== timer = { … } ====

A list of one ore more time ‘rules’ like <code>every minute</code> or <code>at 17:*</code>. See [[#timer_trigger_rules|''timer'' trigger rules]]. If any or the rules matches with the current time/date then your execute function is called. E.g.: <code>on = { timer = { 'between 30 minutes before sunset and 30 minutes after sunrise' } }</code>.


==== variables = { … } ====

A list of one or more user variable-names as defined in Domoticz ( ''Setup > More options > User variables''). If any of the variables listed here is updated, ( '''Note''': update does not necessarily means the variable value or type changed ).the script is executed. '''Note''': Script will only execute when this variable is updated directly by dzVents or by a JSON. If updated with a standard Lua script (using commandArray) or in combination with a time option like afterAAA no event will be triggered.


=== execute = function('''domoticz, item, triggerInfo''') … end ===

When all the above conditions are met (active == true and the on section has at least one matching rule), then this <code>execute</code> function is called. This is the heart of your script. The function has three parameters:


==== 1. ('''domoticz''', item, triggerInfo) ====

The [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]]. This object gives you access to almost everything in your Domoticz system, including all methods to manipulate them—like modifying switches or sending notifications. More about the [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]] below.


==== 2. (domoticz, '''item''', triggerInfo) ====

Depending on what actually triggered the script, <code>item</code> is either a:

* [[#Custom_event_API|customEvent]] 3.0.0
* [[#Device_object_API|device]],
* [[#Variable_object_API_.28user_variables.29|variable]],
* [[#Scene|scene]],
* [[#Group|group]],
* [[#timer_=_%7B_..._%7D|timer]],
* [[#System_event_API|system]], 3.0.0
* [[#Security_Panel|security]] or
* [[#Asynchronous_HTTP_requests|httpResponse]]
* [[#Asynchronous_shell_command_executio|shellCommandResponse]] 3.1.0

Since you can define multiple on-triggers in your script, it is not always clear what the type is of this second parameter. In your code you need to know this in order to properly respond to the different events. To help you inspect the object you can use these attributes like <code>if (item.isDevice) then ... end</code>:

* '''isCustomEvent''': 3.0.0. returns <code>true</code> if the item is a customEvent object.
* '''isDevice''': . returns <code>true</code> if the item is a Device object.
* '''isGroup''': . returns <code>true</code> if the item is a Group object.
* '''isHTTPResponse''': . returns <code>true</code> if the item is an HTTPResponse object.
* '''isShellCommandResponse''': . 3.1.0 returns <code>true</code> if the item is a shellcommandResponse object.
* '''isScene''': . returns <code>true</code> if the item is a Scene object.
* '''isSecurity''': . returns <code>true</code> if the item is a Security object.
* '''isSystemEvent''': 3.0.0. returns <code>true</code> if the item is a system object.
* '''isTimer''': . returns <code>true</code> if the item is a Timer object.
* '''isVariable''': . returns <code>true</code> if the item is a Variable object.
* '''trigger''': . ''string''. the timer rule, the security state, the customEvent or the http response callback string that actually triggered your script. E.g. if you have multiple timer rules can inspect <code>trigger</code> which exact timer rule was fired.


==== 3. (domoticz, item, '''triggerInfo''') ====

'''Note''': as of version 2.4.0, <code>triggerInfo</code> has become more or less obsolete and is left in here for backward compatibility. All information is now available on the <code>item</code> parameter (second parameter of the execute function, see point 2 above).

<code>triggerInfo</code> holds information about what triggered the script. The object has two attributes:

# '''type''': the type of the the event that triggered the execute function, either: - domoticz.EVENT_TYPE_CUSTOM,3.0.0 - domoticz.EVENT_TYPE_DEVICE, - domoticz.EVENT_TYPE_GROUP - domoticz.EVENT_TYPE_HTTPRESPONSE - domoticz.EVENT_TYPE_SCENE, - domoticz.EVENT_TYPE_SECURITY, - domoticz.EVENT_TYPE_SYSTEM,3.0.0 - domoticz.EVENT_TYPE_TIMER, - domoticz.EVENT_TYPE_VARIABLE)
# '''trigger''': the timer rule that triggered the script if the script was called due to a timer event, or the security state that triggered the security trigger rule. See [[#timer_trigger_rules|below]] for the possible timer trigger rules.
# '''scriptName''': the name of the current script.


==== Tip: rename the parameters to better fit your needs ====

The names of the execute parameters are actually something you can change to your convenience. For instance, if you only have one trigger for a specific switch device, you can rename <code>item</code> it to <code>switch</code>. Or if you think <code>domoticz</code> is too long you can rename it to <code>d</code> or <code>dz</code> (might save you a lot of typing and may make your code more readable):

<syntaxhighlight lang="lua">return
{
on =
{
devices = 'mySwitch'
},
execute = function(dz, mySwitch)
dz.log(mySwitch.state, dz.LOG_INFO)
end
}</syntaxhighlight>

=== data = { … } (optional) ===

The optional data section allows you to define local variables that will hold their values ''between'' script runs. These variables can get a value in your execute function and the next time the script is executed these variables will have their previous state restored. For more information see the section [[#Persistent_data|Persistent data]].


=== logging = { … } (optional) ===

The optional logging section allows you to override the global logging setting of dzVents as set in ''Setup > Settings > Other > EventSystem > dzVents Log Level''. This can be handy when you only want this script to have extensive debug logging while the rest of your script executes silently. You have these options:

* '''level''': This is the minimum log level you want for this script. This can be domoticz.LOG_INFO, domoticz.LOG_STATUS, domoticz.LOG_ERROR or domoticz.LOG_DEBUG
* '''marker''': A string that is prefixed before each log message. That way you can easily create a filter in the Domoticz log to see just these messages. '''marker''' defaults to scriptname

<nowiki></nowiki>*LOG_DEBUG will also cause Execution Info to be displayed (start/finished)

Example:

<syntaxhighlight lang="lua">logging = {
level = domoticz.LOG_DEBUG,
marker = "Hey you"
},</syntaxhighlight>

== Some trigger examples ==


=== Custom events ===

Suppose you want to trigger a script not on the minute but 30 seconds later.

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every minute',
},

customEvents =
{
'delayed',
},
},
execute = function(domoticz, item)
if item.isTimer then
domoticz.emitEvent('delayed', domoticz.time.rawTime ).afterSec(30)
else
domoticz.notify('Delayed', 'Event was emitted at ' .. item.data, domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Device changes ===

Suppose you have two devices—a smoke detector ‘myDetector’ and a room temperature sensor ‘roomTemp’, and you want to send a notification when either the detector detects smoke or the temperature is too high:

<syntaxhighlight lang="lua">return
{
on =
{
devices = {
'myDetector',
'roomTemp'
}
},
execute = function(domoticz, device)
if ((device.name == 'myDetector' and device.active) or
(device.name == 'roomTemp' and device.temperature >= 45)) then
domoticz.notify('Fire', 'The room is on fire', domoticz.PRIORITY_EMERGENCY)
end
end
}</syntaxhighlight>

=== Scene / group changes ===

Suppose you have a scene ‘myScene’ and a group ‘myGroup’, and you want to turn on the group as soon as myScene is activated:

<syntaxhighlight lang="lua">return {
on = {
scenes = { 'myScene' }
},
execute = function(domoticz, scene)
if (scene.state == 'On') then
domoticz.groups('myGroup').switchOn()
end
end
}</syntaxhighlight>
Or, if you want to send an email when a group is activated at night:

<syntaxhighlight lang="lua">return {
on = {
groups = { ['myGroup'] = {'at nighttime'} }
},
execute = function(domoticz, group)
if (group.state == 'On') then
domoticz.email('Hey', 'The group is on', 'someone@the.world.org')
end
end
}</syntaxhighlight>

=== Timer events ===

Suppose you want to check the soil humidity every 30 minutes during the day and every hour during the night:

<syntaxhighlight lang="lua">return {
on = {
timer = {
'every 30 minutes at daytime',
'every 60 minutes at nighttime'
}
},
execute = function(domoticz, timer)
domoticz.log('The rule that triggered the event was: ' .. timer.trigger')
if (domoticz.devices('soil').moisture > 100) then
domoticz.devices('irrigation').switchOn().forMin(60)
end
end
}</syntaxhighlight>

=== Variable changes ===

Suppose you have a script that updates a variable ‘myAmountOfMoney’, and if that variable reaches a certain level you want to be notified:

<syntaxhighlight lang="lua">return
{
on =
{
variables = { 'myAmountOfMoney' }
},
execute = function(domoticz, variable)
-- variable is the variable that's triggered
if (variable.value > 1000000) then
domoticz.notify('Rich', 'You can stop working now', domoticz.PRIORITY_HIGH)
end
end
}</syntaxhighlight>

=== Security changes ===

Suppose you have a group holding all the lights in your house, and you want to switch it off as soon as the alarm is activated:

<syntaxhighlight lang="lua">return
{
on =
{
security = { domoticz.SECURITY_ARMEDAWAY }
},
execute = function(domoticz, security)
domoticz.groups('All lights').switchOff()
end
}</syntaxhighlight>

=== Asynchronous HTTP Request and handling ===

Suppose you have some external web service that will tell you what the current energy consumption is and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
httpResponses = { 'energyRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = 'http://url/to/service',
method = 'GET',
callback = 'energyRetrieved'
})
elseif (item.isHTTPResponse) then
if (item.ok) then -- statusCode == 2xx
local current = item.json.consumption
domoticz.devices('myCurrentUsage').updateEnergy(current)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


=== Asynchronous shell command execution 3.1.0 ===

Suppose you have some local shellcommand to measure the speed of your internet connection and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
shellCommandResponses = { 'internetspeedRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.executeShellCommand({
command = 'speedtest-cli --json', -- just an example
callback = 'internetspeedRetrieved', -- see shellCommandResponses above.
timeout = 20, -- max execution time in seconds
})
elseif (item.isShellCommandResponse) then
if (item.statusCode==0) then
domoticz.devices('myCurrentdownloadspeed').updateCustomSensor(item.json.download)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_shell_command_execution|asynchronous shell commands]] for more information.


=== System changes ===

Do some initial work when domoticz starts

<syntaxhighlight lang="lua">return
{
on =
{
system =
{
'start',
'backupDoneDaily',
},

},

execute = function(domoticz, system)
domoticz.log('Domoticz sends ' .. system.type, domoticz.LOG_INFO)

if system.type == 'start' then
domoticz.device('initial device').switchOff().silent
domoticz.variables('special startVar').set('domoticz started at ' .. domoticz.time.rawDateTime )
elseif system.type == 'backupDoneDaily' then
domoticz.notify('Domoticz backup', 'Ended. Backupfile ' .. system.data.location , domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Combined rules ===

Let’s say you have a script that checks the status of a lamp and is triggered by motion detector:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
devices = { 'myDetector' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- the timer was triggered
domoticz.devices('myLamp').switchOff()
elseif (item.isDevice and item.active) then
-- it must be the detector
domoticz.devices('myLamp').switchOn()
end
end
}</syntaxhighlight>

=== At startup trigger ===

You can add <code>at_startup = true</code> to the <code>on</code> section to have your script execute once when Domoticz starts, in addition to any other triggers. This is useful when combined with interval-based rules to avoid waiting for the first interval to pass:

<syntaxhighlight lang="lua">return {
on = {
at_startup = true,
timer = { 'every hour' },
},
execute = function(domoticz, item)
-- Runs immediately when Domoticz starts, then every hour
domoticz.devices('myThermostat').setPoint(21)
end
}</syntaxhighlight>
The <code>at_startup</code> trigger fires on the first timer tick after Domoticz starts (within 2 minutes of startup). It can be combined with any other trigger types (timer, devices, httpResponses, etc.).

'''Note:''' This is different from <code>system = { 'start' }</code> which is a system event trigger. <code>at_startup</code> is simpler - just add the flag and your existing script will also run at startup without needing to check <code>item.isSystemEvent</code>.


== ''timer'' trigger rules ==

There are several options for time triggers. It is important to know that Domoticz timer events only trigger once every minute, so one minute is the smallest interval for your timer scripts. However, dzVents gives you many options to have full control over when and how often your timer scripts are called (all times are in 24hr format and all dates in dd/mm): Keywords recognized are “at, between, every, except, in, on, or” ( except supported from version 3.0.16, or supported from version 3.1.8 ).

At every place you read <astroMoment> you can use one of: sunset, sunrise, solarnoon, midnight '', sunatsouth '', civiltwilightstart, civiltwilightend, astronomicaltwilightstart '', astronomicaltwilightend '', nauticaltwilightstart * or nauticaltwilightend *.

Full daynames are allowed in dzVents >= 3.1.7

* 3.1.16

<syntaxhighlight lang="lua"> on = {
timer = {
'every minute', -- causes the script to be called every minute
'every other minute', -- minutes: xx:00, xx:02, xx:04, ..., xx:58
'every <xx> minutes', -- starting from xx:00 triggers every xx minutes
-- (0 > xx < 60)
'every hour', -- 00:00, 01:00, ..., 23:00 (24x per 24hrs)
'every other hour', -- 00:00, 02:00, ..., 22:00 (12x per 24hrs)
'every <xx> hours', -- starting from 00:00, triggers every xx
-- hours (0 > xx < 24)
'at 13:45', -- specific time
'at *:45', -- every 45th minute in the hour
'at 15:*', -- every minute between 15:00 and 16:00
'at 12:45-21:15', -- between 12:45 and 21:15. You cannot use '*'!
'at 19:30-08:20', -- between 19:30 and 8:20 (next day)
'at 13:45 on mon,tue', -- at 13:45 only on Mondays and Tuesdays (english)
'on mon,tue', -- on Mondays and Tuesdays
'every hour on Saturday', -- you guessed it correctly
'at sunset', -- uses sunset/sunrise/solarnoon info from Domoticz
'at sunrise',
'at <astroMoment>', -- dzVents >= 3.0.16 Uses the times received from Domoticz
'at <astroMoment> on sat,sun',
'xx minutes before <astroMoment>', --
'xx minutes after <astroMoment>', -- Please note that these relative times will cross dates
'between aa and bb' -- aa/bb can be a time stamp like 15:44 (if aa > bb will cross dates)
-- aa/bb can be sunrise/sunset/solarnoon ('between sunset and sunrise' and 'between solarnoon and sunrise' will cross dates)
-- aa/bb can be 'xx minutes before/after <astroMoment>'
'at <astroRange>', -- between <astroMoment>start and <astroMoment>end
'at nighttime', -- between sunset and sunrise
'at daytime', -- between sunrise and sunset
'at daytime on mon,tue', -- between sunrise and sunset only on Mondays and Tuesdays
'in week 1-7,44' -- in week 1-7 or 44
'in week 20-25,33-47' -- between week 20 and 25 or week 33 and 47
'in week -12, 33-' -- week <= 12 or week >= 33
'every odd week',
'every even week', -- odd or even numbered weeks
'on 23/11', -- on 23rd of November (dd/mm)
'on 23/11-25/12', -- between 23/11 and 25/12
'on 2/3-8/3,7/8,6/10-14/10',-- between march 2 and 8, on august 7 and between October 6 and 14.
'on */2,15/*', -- every day in February or
-- every 15th day of the month
'on -3/4,4/7-', -- before 3/4 or after 4/7

'at 12:45-21:15 except at 18:00-18:30', -- between 12:45 and 21:15 but not between 18:00 and 18:30 ( except supported from 3.0.16 onwards )
'at daytime except on sun', -- between sunrise and sunset but not on Sundays
'at daytime or at 23:12', -- between sunrise and sunset and also at 23:12

-- or if you want to go really wild and combine them:
'at nighttime at 21:32-05:44 every 5 minutes on sat, sun except at 04:00', -- except supported from 3.0.16 onwards
'every 10 minutes between 20 minutes before sunset and 30 minutes after sunrise on mon,fri,tue on 20/5-18/8'

-- or just do it yourself:
function(domoticz)
-- you can use domoticz.time to get the current time
-- note that this function is called every minute!
-- custom code that either returns true or false
...
end
},
}</syntaxhighlight>
The timer events are triggered every minute. If such a trigger occurs, dzVents will scan all timer-based events and will evaluate the timer rules. So, if you have a rule <code>on mon</code> then the script will be executed ''every minute'' but only on Monday.

Be mindful of the logic if using multiple types of timer triggers. It may not make sense to combine a trigger for a specific or instantaneous time with a trigger for a span or sequence of times (like ‘at sunset’ with ‘every 6 minutes’) in the same construct. Similarly, <code>'between aa and bb'</code> only makes sense with instantaneous times for <code>aa</code> and <code>bb</code>.

'''One important note: if Domoticz, for whatever reason, skips a timer event then you may miss the trigger! Therefore, you should build in some fail-safe checks or some redundancy if you have critical time-based stuff to control. There is nothing dzVents can do about it'''

'''Tip:''' If you want your timer script to also run at Domoticz startup (instead of waiting for the first timer match), add <code>at_startup = true</code> to your <code>on</code> section. See [[#at-startup-trigger|At startup trigger]].

Another important issue: the way it is implemented right now, the <code>every xx minutes</code> and <code>every xx hours</code> is a bit limited. The interval resets at every *:00 (for minutes) or 00:* for hours. You need an interval that is an integer divider of 60 (or 24 for the hours). So you can do every 1, 2, 3, 4, 5, 6, 10, 12, 15, 20 and 30 minutes only.


= The domoticz object =

The domoticz object passed as the first parameter to the <code>execute</code> function contains everything you need to interact with your domotica system. It provides all information made available by the domoticz event system about your custom- and system events, devices, scenes, groups, hardware modules and variables and has methods needed to inspect and manipulate them. Getting this information is easy:

<code>domoticz.time.isDayTime</code> or <code>domoticz.devices('My sensor').temperature</code> or <code>domoticz.devices('My sensor').lastUpdate.minutesAgo</code>.

The domoticz object consists of a logically arranges structure. It harbors all methods to manipulate Domoticz. dzVents will take care to notify Domoticz with all your intended changes and actions. Earlier you had to fill a commandArray with obscure commands. That’s no longer the case.

Some more examples: <code>domoticz.devices(123).switchOn().forMin(5).afterSec(10)</code> or <code>domoticz.devices('My dummy sensor').updateBarometer(1034, domoticz.BARO_THUNDERSTORM)</code>.

One tip before you get started: '''Make sure that all your devices have unique names. dzVents will give you warnings in the logs if device names are not unique.'''


== Domoticz object API (Application Programming Interface) ==

The domoticz object holds all information about your Domoticz system. It has global attributes and methods to query and manipulate your system. It also has a collection of '''devices''', '''variables''' (user variables in Domoticz), '''scenes''', '''groups''', '''hardware'''. Each of these collections has four iterator functions: <code>find(), forEach()</code>, <code>filter()</code> and <code>reduce()</code> to make searching for devices easier. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]].


=== Domoticz attributes and methods ===

* '''devices(idx/name)''': ''Function''. A function returning a device by idx or name: <code>domoticz.devices(123)</code> or <code>domoticz.devices('My switch')</code>. For the device API see [[#Device_object_API|Device object API]]. To iterate over all devices do: <code>domoticz.devices().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.devices()) do .. end</code>.
* '''dump([osfile]3.0.0)''': ''Function''. Dump all domoticz.settings attributes to the Domoticz log. This ignores the log level setting.
* '''email(subject, message, mailTo [, delay]3.0.10)''': ''Function''. Send email. Optional parm delay is delay in seconds.
* '''emitEvent(name,[extra data ])''':''Function''. 3.0.0 Have Domoticz ‘call’ a customEvent. If you just pass a name then Domoticz will execute the script(s) that subscribed to the named customEvent after your script has finished. You can optionally pass extra information as a string or table. A table will be automatically converted into a json string and converted back to a table in the subscribed script(s). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''executeShellCommand(command/options)''': ''Function''. 3.1.0 Have Domoticz ‘call’ a command. If you just pass a command then Domoticz will execute the command after your script has finished but you will not get notified. If you pass options table with a callback then you have the possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_shell_command_execution|asynchronous shell commands]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. '''Note Make sure that when you use this function on a Windows system and use one or more of the special chars &<>()@^| outside double quotes, you will have to escape these with a ^ char '''
* '''groups(idx/name)''': ''Function'': A function returning a group by name or idx. Each group has the same interface as a device. To iterate over all groups do: <code>domoticz.groups().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.groups()) do .. end</code>. Read more about [[#Group|Groups]].
* '''hardwareInfo(idx/name)''': 3.0.6 ''Function'': A function returning hardwareInfo of a hardware module by name or idx. The return of the function is a table with attributes name, type, typeValue, deviceNames (table with names of all active devices defined on this hardware) and deviceIds (table with idx of all active devices defined on this hardware)
* '''hardware(idx/name)''': 3.0.7 ''Function'': A function returning a hardware module by name or idx. Each hardware has an interface comparable to group. To iterate over all hardware do: <code>domoticz.hardware().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.hardware()) do .. end</code>. Read more about [[#Hardware|Hardware]].
* '''helpers''': ''Table''. Collection of shared helper functions available to all your dzVents scripts. See [[#Shared_helper_functions|Shared helper functions]].
* '''log(message, [level])''': ''Function''. Creates a log entry in the Domoticz log but respects the log minimum level settings. You can provide the loglevel: <code>domoticz.LOG_INFO</code>, <code>domoticz.LOG_STATUS</code>, <code>domoticz.LOG_ERROR</code>, <code>domoticz.LOG_DEBUG</code> or <code>domoticz.LOG_FORCE</code>. In Domoticz settings you can set the default log level for dzVents.
* '''moduleLabel''': 3.0.3 Module (script) name without extension.
* '''notify(subject, message [,priority][,sound][,extra][,subsystem][,delay]3.0.10 )''': ''Function''. Send a notification (like Prowl). Priority can be like <code>domoticz.PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY</code>. <code>extra</code> is notification subsystem specific. For NSS_FIREBASE you can use this field to specify the target mobile (‘midx_1’, midx_2, etc..) or specify <code>device.id</code> so the receiver knows which device triggered the notification. For sound see [[#Constants|list of dzVents Constants]] for the SOUND constants below. <code>subsystem</code> defaults to all subsystems but can be one subsystem or a table containing one or more notification subsystems. See [[#Constants|list of dzVents Constants]] for <code>domoticz.NSS_subsystem</code> types. Delay is delay in seconds
* '''openURL(url/options)''': ''Function''. Have Domoticz ‘call’ a URL. If you just pass a url then Domoticz will execute the url after your script has finished but you will not get notified. If you pass a table with options then you have to possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_HTTP_requests|asynchronous http requests]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''scenes(idx/name)''': ''Function'': A function returning a scene by name or id. Each scene has the same interface as a device. See [[#Device_object_API|Device object API]]. To iterate over all scenes do: <code>domoticz.scenes().forEach(..)</code>. See [[#looping-through-the-collections-iterators|Looping through the collections: iterators]]. (#Looping_through_the_collections:_iterators). Note that you cannot do <code>for i, j in pairs(domoticz.scenes()) do .. end</code>. Read more about [[#Scene|Scenes]].
* '''security''': Holds the state of the security system e.g. <code>Armed Home</code> or <code>Armed Away</code>.
* '''sendCommand(command, value[, delay] 3.0.10)''': Generic (low-level)command method (adds it to the commandArray) to the list of commands that are being sent back to domoticz. Optional parm delay is delay in seconds ''There is likely no need to use this directly. Use any of the device methods instead (see below).''
* '''settings''':
** '''domoticzVersion''': domoticz version string.
** '''dzVentsVersion''': dzVents version string.
** '''location'''
*** '''latitude''': domoticz settings locations latitude.
*** '''longitude''': domoticz settings locations longitude.
*** '''name''': domoticz settings location Name.
** '''secureServer''': ''boolean'' 3.1.1 true when domoticz can be accessed via https.
** '''serverPort''': webserver listening port used by dzVents to access domoticz API.
** '''url''': internal url to access the API service.
** '''webRoot''': <code>webroot</code> 3.1.1 value as specified when starting the Domoticz service (or default).
** '''wwwBind''': <code>wwwbind</code> 3.1.4 value as specified when starting the Domoticz service (or default).
* '''sms(message [, delay] 3.0.10 )''': ''Function''. Sends an sms if it is configured in Domoticz. Optional parm delay is delay in seconds.
* '''snapshot(cameraID(s) or camera Name(s)3.0.13,subject)''': ''Function''. Sends email with a camera snapshots if email is configured and set for attachments in Domoticz. Send 1 or multiple camerIDs -names in ; separated string or array.

<syntaxhighlight lang="lua"> dz.snapshot() -- defaults to id = 1, subject domoticz
dz.snapshot(1,'dz') -- subject dz
dz.snapshot('1;2;3') -- ; separated string
dz.snapshot({1,4,7}) -- table
dz.snapshot('test;test2') -- ; separated string
dz.snapshot({'test', 'test2'}) -- table</syntaxhighlight>
<ul>
<li>'''switchTimerPlan(idx)''': ''Function''. Switch the active timer plan to the plan with the given database ID. <code>idx</code> must be a positive integer matching an existing timer plan ID (as shown in '''Settings → Timer Plans'''). Invalid or non-existent plan IDs are silently ignored. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''startTime''': ''[[#Time_object|Time Object]]''. Returns the startup time of the Domoticz service.</li>
<li>'''systemUptime''': ''Number''. Number of seconds the system is up.</li>
<li>'''time''': ''[[#Time_object|Time Object]]'': Current system time. Additional to Time object attributes:
<ul>
<li>'''isDayTime''': ''Boolean''</li>
<li>'''isNightTime''': ''Boolean''</li>
<li>'''isCivilDayTime''': ''Boolean''.</li>
<li>'''isCivilNightTime''': ''Boolean''.</li>
<li>'''isToday''': ''Boolean''. Indicates if the device was updated today</li>
<li>'''sunriseInMinutes''': ''Number''. Number of minutes since midnight when the sun will rise.</li>
<li>'''sunsetInMinutes''': ''Number''. Number of minutes since midnight when the sun will set.</li>
<li>'''civTwilightStartInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will start.</li>
<li>'''civTwilightEndInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will end.</li></ul></li>
<li>'''triggerHTTPResponse([httpResponse], [delay], [message])''': ''Function''. Creates a callback by sending a logmessage. httpResponse defaults to scriptname, delay defaults to 0 (immediate), message defaults to httpResponse. Left in for backward compatibility only. You can use emitEvent / customEvents now.</li>
<li>'''triggerIFTTT(makerName [,sValue1, sValue2, sValue3])''': ''Function''. Have Domoticz ‘call’ an IFTTT maker event. makerName is required, 0-3 sValue’s are optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''utils''': . A subset of handy utilities: Note that these functions must be preceded by domoticz.utils. If you use more then a few declare something like local _u = domoticz.utils at the beginning of your script and use _u.functionName in the remainder. Example:
<syntaxhighlight lang="lua"> _u = domoticz.utils
print(_u.rightPad('test',10) .. '|||') -- => test |||</syntaxhighlight>
<ul>
<li>'''_.lodashFunctions''': This is an entire collection with very handy Luafunctions. Read more about [[#lodash_for_Lua|lodash]]. E.g.: <code>{.lua} domoticz.utils._.size({'abc', 'def'}))` Returns 2.</code></li>
<li>'''cameraExists(parm)''': ''Function'': returns name when entered with a valid camera 3.0.12 or cameraID and return ID when entered with valid cameraName or false when not a camera, cameraID or cameraName of an existing camera</li>
<li>'''deviceExists(parm)''': ''Function'': returns name when entered with a valid device 3.0.12 or deviceID and returns ID when entered with valid deviceName or false when not a device, deviceID or deviceName of an existing (and active) device. Example:
<syntaxhighlight lang="lua">local dz = domoticz
local _u = dz.utils
if _u.deviceExists('myDevice') then
dz.devices('myDevice').switchOn()
else
dz.log('Device myDevice does not exist!', dz.LOG_ERROR)
end

local myName = _u.deviceExists(123)
if myName then
dz.log('Device 123 is ' .. myName, dz.LOG_INFO)
else
dz.log('Device 123 does not exist', dz.LOG_ERROR)
end</syntaxhighlight></li>
<li>'''dumpTable(table,[levelIndicator],[osfile]3.0.0))''': ''Function'': print table structure and contents to log</li>
<li>'''fileExists(path)''': ''Function'': Returns <code>true</code> if the file (with full path) exists.</li>
<li>'''fromBase64(string)''': ''Function'': Decode a base64 string</li>
<li>'''fromJSON(json, fallback, deSerialize 3.1.8 )''': ''Function''. Turns a json string to a Lua table. Example: <code>local t = domoticz.utils.fromJSON('{ "a": 1 }')</code>. Followed by: <code>print( t.a )</code> will print 1. Optional 2nd param fallback will be returned if json is nil or invalid. Optional 3rd param deSerialize (boolean) determines if the JSON should be deserialized before converting.</li>
<li>'''fromXML(xml, fallback )''': ''Function'': Turns a xml string to a Lua table. Example: <code>local t = domoticz.utils.fromXML('<testtag>What a nice feature!</testtag>') Followed by:</code>print( t.texttag)` will print What a nice feature! Optional 2nd param fallback will be returned if xml is nil or invalid.</li>
<li>'''fuzzyLookup([string|array of strings], parm)''': ''Function'': 3.0.14. Search fuzzy matching string in parm. If parm is string it returns a number (lower is better match). If parm is array of strings it returns the best matching string.</li>
<li>'''groupExists(parm)''': ''Function'': returns name when entered with a valid group 3.0.12 or groupID and return ID when entered with valid groupName or false when not a group, groupID or groupName of an existing group</li>
<li>'''hardwareExists(parm)''': ''Function'': 3.0.7 returns name when entered with valid hardwareID or ID when entered with valid hardwareName or false when not a hardwareID or hardwareName of an existing (and active )hardware module</li>
<li>'''inTable(table, searchString)''': ''Function'': Returns <code>"key"</code> if table has searchString as a key, <code>"value"</code> if table has searchString as value and <code>false</code> otherwise.</li>
<li>'''isJSON(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘application/json’ or string is enclosed in {} and <code>false</code> otherwise.</li>
<li>'''isXML(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘text/xml’ or ‘application/xml’ or string is enclosed in <> and <code>false</code> otherwise.</li>
<li>'''leftPad(string, length [, character])''': ''Function'': Precede string with given character(s) (default = space) to given length.</li>
<li>'''centerPad(string, length [, character])''': ''Function'': Center string by preceding and succeeding with given character(s) (default = space) to given length.</li>
<li>'''numDecimals(number [, integer [, decimals ]])''': ''Function'': Format number to float representation. ''Examples:''</li></ul>

<syntaxhighlight lang="lua"> domoticz.utils.numDecimals(12.23, 4, 4) -- => 12.2300,
domoticz.utils.numDecimals (12.23,1,1) -- => 12.2,
domoticz.utils.leadingZeros(domoticz.utils.numDecimals (12.23,4,4),9) -- => 0012.2300</syntaxhighlight>
<ul>
<li>'''osCommand(cmd)''': ''Function'': 3.0.13 Execute an OS command and return result and returncode. Note: For long running scripts <code>domoticz.executeShellCommand()</code> should be used, See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''osExecute(cmd)''': ''Function'': Execute an OS command (no return). Note: For long running scripts <code>executeShellCommand()</code> should be used. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''rightPad(string, length [, character])''': ''Function'': Succeed string with given character(s) (default = space) to given length.</li>
<li>'''round(number, [decimalPlaces])''': ''Function''. Helper function to round numbers. Default decimalPlaces is 0.</li>
<li>'''sceneExists(parm)''': ''Function'': returns name when entered with valid scene 3.0.12 or sceneID and return ID when entered with valid sceneName or false when not a scene, sceneID or sceneName of an existing scene</li>
<li>'''setLogMarker([marker])''': ''Function'': set logMarker to ‘marker’. Defaults to scriptname. Can be used to change logMarker based on flow in script</li>
<li>'''splitLine(string , splitOnWord ) 3.1.8)''':''Function''. Helper function to split a line. Return is a table with line-segments.</li>
<li>'''stringSplit(string [,separator ] [,convertNumber ][,convertNil ]3.0.17)''':''Function''. Helper function to split a line in separate words. Default separator is space. Return is a table with separated words. Default convertNumber is false when set to true it will convert strings to number where possible. Word is ignored when nil, unless convertNil is set; in that case word will be set to the convertNil value.</li>
<li>'''stringToSeconds(str)''': ''Function'': 3.0.1 Returns number of seconds between now and str. ''Examples:''
<syntaxhighlight lang="lua">domoticz.utils.stringToSeconds('09:00') -- number of seconds between now and 09:00 hr.
domoticz.utils.stringToSeconds('08:53:30 on fri') -- number of seconds between now and Friday at 08:53:30
domoticz.utils.stringToSeconds('08:53:30 on sat, sun') -- number of seconds between now and Saturday or Sunday at 08:53:30 ;whatever comes first</syntaxhighlight></li>
<li>'''toBase64(string)''': ''Function'': ) Encode a string to base64</li>
<li>'''toCelsius(f, relative)''': ''Function''. Converts temperature from Fahrenheit to Celsius along the temperature scale or when relative == true it uses the fact that 1F = 0.56C. So <code>toCelsius(5, true)</code> returns 5F*(1/1.8) = 2.78C.</li>
<li>'''toJSON(luaTable)''': ''Function''. Converts a Lua table to a json string.</li>
<li>'''toXML(luaTable, [header])''': ''Function''. Converts a Lua table to a xml string.</li>
<li>'''urlDecode(s)''': ''Function''. Simple deCoder to convert a string with escaped chars (%20, %3A and the likes) to human readable format.</li>
<li>'''urlEncode(s, [strSub])''': ''Function''. Simple url encoder for string so you can use them in <code>openURL()</code>. <code>strSub</code> is optional and defaults to + but you can also pass %20 if you like/need.</li>
<li>'''variableExists(parm)''': ''Function'': returns name when entered with a valid variable 3.0.12 or variableID and return ID when entered with valid variableName or false when not a variable, variableID or variableName of an existing variable</li>
<li>'''leadingZeros(number, length)''': ''Function'': Precede number with given zeros to given length.</li>
<li>'''variables(idx/name)''': ''Function''. A function returning a variable by it’s name or idx. See [Variable object API] (#Variable_object_API_.28user_variables.29) for the attributes. To iterate over all variables do: <code>domoticz.variables().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. '''Note that you cannot do <code>for i, j in pairs(domoticz.variables()) do .. end</code>'''.</li></ul></li></ul>


=== Looping through the collections: iterators ===

The domoticz object has these collections (tables): devices, scenes, groups, variables, changedDevices and changedVariables. You cannot use the <code>pairs()</code> or <code>ipairs()</code> functions. Therefore dzVents has four iterator methods:

# '''find(function)''': Returns the item in the collection for which <code>function</code> returns true. When no item is found <code>find</code> returns nil.
# '''forEach(function)''': Executes function once per array element. The function receives the item in the collection (device or variable). If the function returns ''false'', the loop is aborted.
# '''filter(function / table)''': returns items in the collection for which the function returns true. You can also provide a table with names and/or ids.
# '''reduce(function, initial)''': Loop over all items in the collection and do some calculation with it. You call it with the function and the initial value. Each iteration the function is called with the accumulator and the item in the collection. The function does something with the accumulator and returns a new value for it.


==== Examples: ====

find():

<syntaxhighlight lang="lua"> local myDevice = domoticz.devices().find(function(device)
return device.name == 'myDevice'
end)
domoticz.log('Id: ' .. myDevice.id)</syntaxhighlight>
forEach():

<syntaxhighlight lang="lua"> domoticz.devices().forEach(function(device)
if (device.batteryLevel < 20) then
-- do something
end
end)</syntaxhighlight>
filter():

<syntaxhighlight lang="lua"> local deadDevices = domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end)
deadDevices.forEach(function(zombie)
-- do something
end)</syntaxhighlight>
or

<syntaxhighlight lang="lua"> local livingLights = {
'window',
'couch',
33, -- kitchen light id
}
local lights = domoticz.devices().filter(livingLights)
lights.forEach(function(light)
-- do something
light.switchOn()
end)</syntaxhighlight>
Of course you can chain:

<syntaxhighlight lang="lua"> domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end).forEach(function(zombie)
-- do something with the zombie
end)</syntaxhighlight>
Using a reducer to count all devices that are switched on:

<syntaxhighlight lang="lua"> local count = domoticz.devices().reduce(function(acc, device)
if (device.state == 'On') then
acc = acc + 1 -- increase the accumulator
end
return acc -- always return the accumulator
end, 0) -- 0 is the initial value for the accumulator</syntaxhighlight>

=== Constants ===

The domoticz object has these constants available for use in your code e.g. <code>domoticz.LOG_INFO</code>.

'''IMPORTANT: you have to prefix these constants with the name of your domoticz object. Example: <code>domoticz.ALERTLEVEL_RED</code>''':

* '''ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_ORANGE, ALERTLEVEL_RED, ALERTLEVEL_YELLOW''': for updating text sensors.
* '''BASETYPE_CUSTOM_EVENT 3.0.0,BASETYPE_DEVICE, BASETYPE_SCENE, BASETYPE_GROUP, BASETYPE_HARDWARE''' 3.0.7, '''BASETYPE_VARIABLE, BASETYPE_SECURITY, BASETYPE_TIMER, BASETYPE_HTTP_RESPONSE, BASETYPE_SYSTEM'''3.0.0: indicators for the various object types that are passed as the second parameter to the execute function. E.g. you can check if an object is a device object: <code>Lua if (item.baseType == domoticz.BASETYPE_DEVICE) then ... end</code>
* '''BARO_CLOUDY, BARO_CLOUDY_RAIN, BARO_STABLE, BARO_SUNNY, BARO_THUNDERSTORM, BARO_NOINFO, BARO_UNSTABLE, BARO_COMPUTE''' : for updating barometric values.
* '''EVENT_TYPE_DEVICE, EVENT_TYPE_VARIABLE, EVENT_TYPE_CUSTOM''', 3.0.0 '''EVENT_TYPE_SECURITY, EVENT_TYPE_HTTPRESPONSE, EVENT_TYPE_SYSTEM,''' 3.0.0 '''EVENT_TYPE_TIMER''': triggerInfo types passed to the execute function in your scripts.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_TEMPORARY_OVERRIDE, EVOHOME_MODE_PERMANENT_OVERRIDE, EVOHOME_MODE_FOLLOW_SCHEDULE''': mode for EvoHome system.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_AUTOWITHRESET, EVOHOME_MODE_AUTOWITHECO, EVOHOME_MODE_AWAY, EVOHOME_MODE_DAYOFF, EVOHOME_MODE_CUSTOM, EVOHOME_MODE_HEATINGOFF''' : mode for EvoHome controller
* '''HUM_COMFORTABLE, HUM_DRY, HUM_NORMAL, HUM_WET, HUM_COMPUTE''' 3.0.15: constant for humidity status.
* '''INTEGER, FLOAT, STRING, DATE, TIME''': variable types.
* <nowiki></nowiki>**LOG_INFO, LOG_STATUS, LOG_ERROR, LOG_DEBUG, LOG_FORCE: for logging messages. LOG_FORCE will always be displayed.
* '''NSS_CLICKATELL''' 3.1.3, '''NSS_FIREBASE, NSS_FIREBASE_CLOUD_MESSAGING, NSS_GOOGLE_DEVICES,''' 3.0.10 Only with installed casting plugin, '''NSS_HTTP, NSS_KODI, NSS_LOGITECH_MEDIASERVER, NSS_NMA,NSS_PROWL, NSS_PUSHALOT, NSS_PUSHBULLET, NSS_PUSHOVER, NSS_PUSHSAFER, NSS_TELEGRAM, NSS_GOOGLE_CLOUD_MESSAGING''' deprecated by Google and replaced by firebase: for notification subsystem
* '''PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY''': for notification priority.
* '''SECURITY_ARMEDAWAY, SECURITY_ARMEDHOME, SECURITY_DISARMED''': for security state.
* '''STATE_IDLE, STATE_COOLING, STATE_HEATING''': for thermostat operating state.
* '''SOUND_ALIEN , SOUND_BIKE, SOUND_BUGLE, SOUND_CASH_REGISTER, SOUND_CLASSICAL, SOUND_CLIMB , SOUND_COSMIC, SOUND_DEFAULT, SOUND_ECHO, SOUND_FALLING, SOUND_GAMELAN, SOUND_INCOMING, SOUND_INTERMISSION, SOUND_MAGIC, SOUND_MECHANICAL, SOUND_NONE, SOUND_PERSISTENT, SOUND_PIANOBAR , SOUND_SIREN, SOUND_SPACEALARM, SOUND_TUGBOAT, SOUND_UPDOWN''': for notification sounds.


== Custom event API ==

If you have a dzVents script that is triggered by a customEvent in Domoticz then the second parameter passed to the execute function will be a ''notification'' object. The object.type = customEvent (isCustomEvent: true) and object.data contains the passed data to this script. object.trigger is the name of the customEvent that triggered the script.


== Device object API ==

If you have a dzVents script that is triggered by switching a device in Domoticz then the second parameter passed to the execute function will be a ''device'' object. Also, each device in Domoticz can be found in the <code>domoticz.devices()</code> collection (see above). The device object has a set of fixed attributes like ''name'' and ''idx''. Many devices, however, have different attributes and methods depending on their (hardware)type, subtype and other device specific identifiers. It is possible that you will get an error if you call a method on a device that doesn’t support it, so please check the device properties for your specific hardware to see which are supported (can also be done in your script code!).

dzVents recognizes most of the different device types in Domoticz and creates the proper attributes and methods. It is possible that your device type has attributes that are not recognized; if that’s the case, please create a ticket in the Domoticz [https://github.com/domoticz/domoticz/issues issue tracker on GitHub], and an adapter for that device will be added.

If for some reason you miss a specific attribute or data for a device, then likely the <code>rawData</code> attribute will have that information.


== Device attributes and methods for all devices ==

<ul>
<li>'''active''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Same as bState.</li>
<li>'''baseType''' ''String''. ‘camera’, ‘device’, ‘group’, ‘scene’, ‘hardware’, ‘uservariable’ or ‘security’</li>
<li>'''batteryLevel''': ''Number'' If applicable for that device then it will be from 0-100.</li>
<li>'''bState''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Better to use active.</li>
<li>'''changed''': ''Boolean''. True if the device was updated. '''Note''': This does not necessarily means the device state or value changed.</li>
<li>'''customImage''': ''Number''. When customImage is used for the device-icon this will be the icon-number. It will be 0 if the icon was not changed.</li>
<li>'''description''': ''String''. Description of the device.</li>
<li>'''deviceId''': ''String''. Another identifier of devices in Domoticz. dzVents uses the id(x) attribute. See device list in Domoticz’ settings table.</li>
<li>'''deviceSubType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''deviceType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''dump()''': ''Function''. Dump all attributes except functions and complete time overview to the Domoticz log. This ignores the log level setting. Use fullDump to include everything.</li>
<li>'''dumpSelection([{‘attributes’} ‘functions’ ‘tables’])''': ''Function''. 3.0.5 Dump attributes, function-names or table-names to the Domoticz log. This ignores the log level setting.</li>
<li>'''fullDump()''' ''Function''. 3.1.16 Dump all attributes including functions and the complete time overview to the Domoticz log. This ignores the log level setting. Most of the time dump() shows everything what is needed to debug.</li>
<li>'''hardwareName''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareId''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''icon''': ''String''. Name of the icon in Domoticz GUI.</li>
<li>'''id''': ''Number''. Index of the device. You can find the index in the device list (idx column) in Domoticz settings. It’s not truly an index but is unique enough for dzVents to be treated as an id.</li>
<li>'''idx''': ''Number''. Same as id: index of the device</li>
<li>'''inActive''': ''Boolean''. 3.1.0 true if active is false and vice versa. If active is nil inActive is also nil</li>
<li>'''lastUpdate''': ''[[#Time_object|Time Object]]'': Time when the device was updated. **Note: The lastUpdate for devices that triggered the script at hand is in fact the previousUpdate time. The real lastUpdate time for these “script triggering” devices is the current time.</li>
<li>'''name''': ''String''. Name of the device.</li>
<li>'''nValue''': ''Number''. Numerical representation of the state.</li>
<li>'''protected''': ''Boolean''. True when device / scene / group is protected. False otherwise.</li>
<li>'''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]</li>
<li>'''protectionOn()''': ''Function''. switch protection to on. Supports some [command options] !! **Note: domoticz protects against GUI and API access only. switchOn / switchOff type Blockly / Lua / dzVents commands are not influenced (because they are executed as admin user)</li>
<li>'''rawData''': ''Table'': All values are ''String'' types and hold the raw data received from Domoticz.</li>
<li>'''rename(newName)''': ''Function''. Change current devicename to new devicename Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setDescription(description)''': ''Function''. Generic method to update the description for all devices, groups and scenes. E.g.: device.setDescription(device.description .. ‘/nChanged by’.. item.trigger .. ‘at’ .. domoticz.time.raw). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setIcon(iconNumber)''': ''Function''. method to update the icon for devices. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setState(newState)''': ''Function''. Generic update method for switch-like devices. E.g.: device.setState(‘On’). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''resumeTimerPlan()''': ''Function''. Finds the most recent timer that should have fired today (before now) for this device, scene, or group and executes it immediately. Useful for restoring the correct state after a Domoticz restart or power cut. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. ```lua – Replay last timer for a device domoticz.devices(‘My Light’).resumeTimerPlan()
– Replay last timer for a scene domoticz.scenes(‘Evening Scene’).resumeTimerPlan()
– Replay last timer for a group domoticz.groups(‘All Lights’).resumeTimerPlan() ```</li>
<li>'''setValues(nValue,[ sValue1, sValue2, …])''': ''Function''. Generic alternative method to update device nValue, sValues. Uses domoticz JSON API to force subsequent pushes like influxdb and MQTT. nValue required but when set to nil it defaults to current nValue. sValue parms are optional and can be many. 3.0.8 If one of sValue parms is ‘parsetrigger’, subsequent eventscripts will be triggered.</li>
<li>'''state''': ''String''. For switches, holds the state like ‘On’ or ‘Off’. For dimmers that are on, it is also ‘On’ but there is a level attribute holding the dimming level. '''For selector switches''' (Dummy switch) the state holds the ''name'' of the currently selected level. The corresponding numeric level of this state can be found in the '''rawData''' attribute: <code>device.rawData[1]</code>.</li>
<li>'''signalLevel''': ''Number'' If applicable for that device then it will be from 0-12</li>
<li>'''switchType''': ''String''. See Domoticz devices table in Domoticz GUI(Switches tab). E.g. ‘On/Off’, ‘Door Contact’, ‘Motion Sensor’ or ‘Blinds’</li>
<li>'''sValue''': ''String''. Returns the sValue (string Value) of a device.</li>
<li>'''switchTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''timedOut''': ''Boolean''. Is true when the device couldn’t be reached.</li>
<li>'''unit''': ''Number''. Device unit. See device list in Domoticz’ settings for the unit.</li>
<li>'''update(< params >)''': ''Function''. Generic update method. Accepts any number of parameters that will be sent back to Domoticz. There is no need to pass the device.id here. It will be passed for you. Example to update a temperature: <code>device.update(0,12)</code>. This will eventually result in a commandArray entry <code>['UpdateDevice']='<idx>|0|12'</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''updateQuiet(nValue, sValue)''': ''Function''. 3.0.18 Uses the JSON/API to send nValue and/or sValue to domoticz (at least one should be supplied). Will update the device status in the GUI and trigger events but will not execute the action on the device. Only useful when the status in the GUI is not in line with the actual status. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li></ul>


=== Device attributes and methods for specific devices ===

Note that if you do not find your specific device type here you can always inspect what is in the <code>rawData</code> attribute. Please let us know that it is missing so we can write an adapter for it (or you can write your own and submit it). Calling <code>myDevice.dump()</code> will dump all attributes and values for myDevice to the Domoticz log.


==== Air quality ====

* '''co2''': ''Number''. PPM
* '''quality''': ''String''. Air quality string.
* '''updateAirQuality(ppm)''': Pass the CO2 concentration. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Alert sensor ====

* '''color''': ''Number''. Color of the alert. See domoticz color constants for possible values.
* '''text''': ''String''
* '''updateAlertSensor(level, text)''': ''Function''. Level can be domoticz.ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_YELLOW, ALERTLEVEL_ORANGE, ALERTLEVEL_RED. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 1-phase ====

* '''current''': ''Number''. Ampère.
* '''updateCurrent(current)''': ''Function''. Current in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 3-phase ====

* '''current1''', '''current2''', '''current3''' : ''Number''. Ampère.
* '''updateCurrent(current1, current2, current3)''': ''Function''. Currents in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Barometer sensor ====

* '''barometer'''. ''Number''. Barometric pressure.
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''updateBarometer(pressure, forecast)''': ''Function''. Update barometric pressure. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Counter, managed Counter, counter incremental ====

* '''counter''': ''Number''
* '''counterToday''': ''Number''. Today’s counter value.
* '''updateCounter(value)''': ''Function''. '''Overwrite current value for managed and standard counters; increment for incremental counters !!'''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateHistory( date, sValues )''': ''Strings'' 3.1.3 ''function'' Managed counter only! Used to write values to short or long term storage.

<syntaxhighlight lang="lua"> local mCounter = domoticz.devices('device name')
mCounter.updateHistory('2021-01-22', '10;1777193') -- Write to long term storage (meter_calendar table)
mCounter.updateHistory('2021-01-22 10:05:02', '10;1777193') -- Write to short term storage (meter table)</syntaxhighlight>
* '''incrementCounter(value)''': ''Function''. (counter incremental) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. To update with a complete new value you will have to do some calculation and take the counter divider into account.

<syntaxhighlight lang="lua"> local newValue = value
local iCounter = domoticz.devices('device name')
local counterDivider = x -- x is depending on the counter divider set for the device
iCounter.incrementCounter( ( -1 * iCounter.counter * counterDivider ) + newValue )</syntaxhighlight>
* '''valueQuantity''': ''String''. For counters.
* '''valueUnits''': ''String''.


==== Custom sensor ====

* '''sensorType''': ''Number''.
* '''sensorUnit''': ''String'':
* '''sensorValue''': 3.0.11 ''Number'' where applicable; else ''String'':
* '''updateCustomSensor(value)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Distance sensor ====

* '''distance''': ''Number''.
* '''updateDistance(distance)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Electric usage ====

* '''actualWatt''': ''Number''. Current Watt usage.
* '''WhActual''': ''Number''. Current Watt usage. (please use actualWatt)
* '''updateEnergy(energy)''': ''Function''. In Watt. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Evohome (controller) ====

* '''mode''': ''string'' 3.0.0.
* '''setMode(mode, dparm, action, ooc )''': ''Function''. set mode for controller. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_AUTOWITHRESET, domoticz.EVOHOME_MODE_AUTOWITHECO, domoticz.EVOHOME_MODE_AWAY, domoticz.EVOHOME_MODE_DAYOFF, domoticz.EVOHOME_MODE_CUSTOM or domoticz.EVOHOME_MODE_HEATINGOFF. dParm <optional> can be a future time string (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>), a future time object, a future time as number of seconds since epoch or a number representing a positive offset in minutes (max 1 year). action <optional> (1 = run on action script, 0 = disable), ooc <optional> (1 = only trigger the event & log on change, 0 = always trigger & log)


==== Evohome (hotWater) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''mode''': ''string''
* '''untilDate''': ''string in ISO 8601 format'' or n/a.
* '''setHotWater(state, mode, until)''': ''Function''. set HotWater Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE You can provide an until date (in ISO 8601 format for domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>).


==== Evohome (relay) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''level''': ''number'' (level percentage)
* '''active''': ''boolean'' (true when state is not equal to ‘Off’, false otherwise)


==== Evohome (zones) ====

* '''setPoint''': ''Number''.
* '''mode''': ''string'' .
* '''untilDate''': ''string in ISO 8601 format'' or n/a .
* '''updateSetPoint(setPoint, mode, until)''': ''Function''. Update set point. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE. You can provide an until date (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>). When leaving out untilDate for mode domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE the untilDate will be the next scheduled zone-update time/date. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Gas ====

* '''counter''': ''Number''. Value in m3
* '''counterToday''': ''Number''. Value in m3
* '''updateGas(usage)''': ''Function''. Usage in '''dm3''' (liters). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Group ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current group-name to new group-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleGroup()''': Toggles the state of a group. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Hardware 3.0.7 ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''isHardware''': ''Boolean''
* '''isPythonPlugin''': ''Boolean''
* '''type''': : ''String''
* '''typeValue''': : ''Number''


==== Humidity sensor ====

* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''updateHumidity(humidity, status)''': Update humidity. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Kodi ====

* '''kodiExecuteAddOn(addonId)''': ''Function''. Will send an Execute Addon command sending no parameters. Addon IDs are embedded in the addon configuration and are not to be confused with the Addon Name. For example: http://forums.homeseer.com/showthread.php?p=1213403.
* '''kodiPause()''': ''Function''. Will send a Pause command, only effective if the device is streaming.
* '''kodiPlay()''': ''Function''. Will send a Play command, only effective if the device was streaming and has been paused.
* '''kodiPlayFavorites([position])''': ''Function''. Will play an item from the Kodi’s Favorites list optionally starting at ''position''. Favorite positions start from 0 which is the default.
* '''kodiPlayPlaylist(name, [position])''': ''Function''. Will play a music or video Smart Playlist with ''name'' optionally starting at ''position''. Playlist positions start from 0 which is the default.
* '''kodiSetVolume(level)''': ''Function''. Set the volume for a Kodi device, 0 <= level <= 100.
* '''kodiStop()''': ''Function''. Will send a Stop command, only effective if the device is streaming.
* '''kodiSwitchOff()''': ''Function''. Will turn the device off if this is supported in settings on the device.


==== kWh, Electricity (instant and counter) ====

* '''actualWatt''': ''Number''. Actual usage in Watt.
* '''counterToday''': ''Number''.
* '''updateElectricity(power, energy)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''WhToday''': ''Number''. Total Wh usage of the day. Note the unit is Wh and not kWh!
* '''WhTotal''': ''Number''. Total Wh usage.
* '''WhActual''': ''Number''. Actual reading in Watt. Please use actualWatt


==== Leaf wetness ====

* '''wetness''': ''Number''. Wetness value
* '''updateWetness(wetness)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Logitech Media Server ====

* '''pause()''': ''Function''. Will pause the device if it was streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''play()''': ''Function''. If the device was off, it will turn on and start streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playFavorites([position])''': ''Function''. Will start the favorites playlist. <code>position</code> is optional (0 = default). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playlistID''': ''Nubmer''.
* '''setVolume(level)''': ''Function''. Sets the volume (0 <= level <= 100). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''startPlaylist(name)''': ''Function''. Will start the playlist by its <code>name</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Will stop the device (only effective if the device is streaming). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeUp()''': ''Function''. Will turn the device volume up with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeDown()''': ''Function''. Will turn the device volume down with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Lux sensor ====

* '''lux''': ''Number''. Lux level for light sensors.
* '''updateLux(lux)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Onkyo receiver ====

* '''onkyoEISCPCommand(command)'''. ''Function''. Sends an EISP command to the Onkyo receiver.


==== OpenTherm gateway ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== P1 Smart meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterToday''': ''Number''.
* '''usage1''', '''usage2''': ''Number''.
* '''return1''', '''return2''': ''Number''.
* '''updateP1(usage1, usage2, return1, return2, cons, prod)''': ''Function''. Updates the device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''usageDelivered''': ''Number''.


==== Percentage ====

* '''percentage''': ''Number''.
* '''updatePercentage(percentage)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Philips Hue Light ====

See switch below.


==== Pressure ====

* '''pressure''': ''Number''.
* '''updatePressure(pressure)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Rain meter ====

* '''rain''': ''Number'' (please note that this does return the rain total for today)
* '''rainRate''': ''Number''
* '''updateRain(rate, counter)''': ''Function''. (rate in mm * 100 per hour, counter is total in mm) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== RGBW(W) / Lighting Limitless/Applamp ====

* '''decreaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''getColor()'''; ''Function''. Returns table with color attributes or nil when color field of device is not set.
* '''increaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''setColor(r, g, b, br, cw, ww, m, t)''': ''Function''. Sets the light to requested color. r, g, b required, others optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. Meaning and limits of parms can be found [https://wiki.domoticz.com/Domoticz_API/JSON_URL's#Set_a_light_to_a_certain_color_or_color_temperature here].
* '''setColorBrightness()''': same as setColor
* '''setDiscoMode(modeNum)''': deprecated because only very limited supported and will be removed from API
* '''setHex(r, g, b)''': ''Function''. Sets the light to requested color. r, g, b required (decimal Values 0-255). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setHue(hue, brightness, isWhite)''': ''Function''. Sets the light to requested Hue. Hue and brightness required. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setKelvin(Kelvin)''': ''Function''. Sets Kelvin level of the light (For RGBWW devices only). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setNightMode()''': ''Function''. Sets the lamp to night mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setRGB(red, green, blue)''': ''Function''. Set the lamps RGB color. Values are from 0-255. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setWhiteMode()''': ''Function''. Sets the lamp to white mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scale weight ====

* '''weight''': ''Number''
* '''udateWeight()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scene ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current scene-name to new scene-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Security Panel ====

Create a security device:

# Set a security panel password in Domoticz settings.
# Activate the security panel ('''Setup > More Options > Security Panel''' and set it to '''Disarm''' (using your password)).
# Go to the device list in ('''Setup > Devices''') where it should show the security panel device under ‘Not used’.
# Add the device and give it a name.

Methods/attributes:

* '''armAway()''': Sets a security device to Armed Away. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''armHome()''': Sets a security device to Armed Home. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''disarm()''': Disarms a security device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''state''': ''String'': Same values as domoticz.security value.


==== Smoke detection ====

* '''activate()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''reset()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Solar radiation ====

* '''radiation'''. ''Number''. In Watt/m2.
* '''updateRadiation(radiation)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Soil moisture ====

* '''moisture'''. ''Number''. In centibars (cB).
* '''updateSoilMoisture(moisture)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Sound level ====

* '''level'''. ''Number''. In dB.
* '''updateSoundLevel(level)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Switch (dimmer, selector etc.) ====

There are many switch-like devices. Not all methods are applicable for all switch-like devices. You can always use the generic <code>setState(newState)</code> method.

* '''close()''': ''Function''. Set device to Close if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''dimTo(percentage)''': ''Function''. Switch a dimming device on and/or dim to the specified level. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''lastLevel''': Number. The level of a dimmer just before it was switched off. '''Note: lastLevel only shows you the previous level if you have a trigger for the device itself. So for instance you have a on-trigger for ‘myDimmer’ and the dimmer is set from 20% to 30%, in your script <code>myDimmer.level == 30</code> and <code>myDimmer.lastLevel == 20</code>. '''
* '''level''': ''Number''. For dimmers and other ‘Set Level..%’ devices this holds the level like selector switches.
* '''levelActions''': ''String''. |-separated list of url actions for selector switches.
* '''levelName''': ''String''. Current level name for selector switches.
* '''levelNames''': ''Table''. Table holding the level names for selector switch devices.
* '''levelVal''': ''Number''. Specific for selector switches.
* '''maxDimLevel''': ''Number''.
* '''open()''': ''Function''. Set device to Open if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOn()''': ''Function''. Set deviceStatus to on without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOff()''': ''Function''. set deviceStatus to off without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setLevel(percentage)''': ''Function''. Set device to a given level if it supports it (e.g. blinds percentage). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Set device to Stop if it supports it (e.g. blinds). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Switch device off it is supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Switch device on if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchSelector(<[level]|[levelname] >)''' : ''Function''. Switches a selector switch to a specific level ( levelname or level(numeric) required ) levelname must be exact, for level the closest fit will be picked. See the edit page in Domoticz for such a switch to get a list of the values). Levelname is only supported when level 0 (“Off”) is not removed Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleSwitch()''': ''Function''. Toggles the state of the switch (if it is togglable) like On/Off, Open/Close etc.


==== Temperature sensor ====

* '''temperature''': ''Number''
* '''updateTemperature(temperature)''': ''Function''. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Barometer sensor ====

* '''barometer''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''temperature''': ''Number''
* '''updateTempBaro(temperature, pressure, forecast)''': ''Function''. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity, Barometer sensor ====

* '''barometer''': ''Number''
* '''dewPoint''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHumBaro(temperature, humidity, status, pressure, forecast)''': ''Function''. forecast can be domoticz.BARO_NOINFO, BARO_SUNNY, BARO_PARTLY_CLOUDY, BARO_CLOUDY, BARO_RAIN. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET, HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity ====

* '''dewPoint''': ''Number''
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHum(temperature, humidity [, status] )''': ''Function''. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET or HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Text ====

* '''text''': ''String''
* '''updateText(text)''': Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat set point ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat Operating state 3.0.19 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat type 3 (Mertik) 3.0.15 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat 6 3.1.11 ====

Thermostat 6 devices come in several subtypes: Temp/Setpoint, Temp/Hum/Setpoint, Temp/Baro/Setpoint and Temp/Hum/Baro/Setpoint.

- '''setPoint''': ''Number''. The current set point.

- '''humidityStatusValue''': ''Number''. Mapped humidity status value (only for subtypes with humidity).

- '''updateSetPoint(setPoint)''': ''Function''. Update the set point. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].

- '''updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)''': ''Function''. Update thermostat values. Parameters depend on the subtype:

* - ''Temp/Setpoint'': <code>updateThermostat(temperature, setPoint)</code>
* - ''Temp/Hum/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus)</code>
* - ''Temp/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, nil, nil, barometer, forecast)</code>
* - ''Temp/Hum/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)</code>
* - <code>forecast</code> can be a string: <code>'noinfo'</code>, <code>'sunny'</code>, <code>'partlycloudy'</code>, <code>'cloudy'</code>, <code>'rain'</code> or a numeric value.
* - <code>humidityStatus</code> can be a string: <code>'dry'</code>, <code>'normal'</code>, <code>'comfortable'</code>, <code>'wet'</code> or a numeric value. If omitted with humidity provided, it is auto-calculated.


==== UV sensor ====

* '''uv''': ''Number''. UV index.
* '''updateUV(uv)''': ''Function''. UV index. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Visibility ====

* '''visibility''': ''Number''. In km.
* '''updateVisibility(distance)''':Function*. In km. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Voltage ====

* '''voltage''': ''Number''.
* '''updateVoltage(voltage)''':Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Waterflow ====

* '''flow''': ''Number''. In L/m.
* '''updateWaterflow(flow)''':Function*. In L/m. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Wind ====

* '''chill''': ''Number''.
* '''direction''': ''Number''. Degrees.
* '''directionString''': ''String''. Formatted wind direction like N, SE.
* '''gust''': ''Number''. ( in meters / second, might change in future releases to Meters/Counters settings for Wind Meter )
* '''gustMs''': ''Number''. Gust ( in meters / second )
* '''temperature''': ''Number''
* '''speed''': ''Number''. Windspeed ( in the unit set in Meters/Counters settings for Wind Meter )
* '''speedMs''': ''Number''. Windspeed ( in meters / second )
* '''updateWind(bearing, direction, speed, gust, temperature, chill)''': ''Function''. Bearing in degrees, direction in N, S, NNW etc, speed in m/s, gust in m/s, temperature and chill in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Youless meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterDeliveredTotal''': ''Number''.
* '''powerYield''': ''String''.
* '''updateYouless(total, actual)''': ''Function''.


==== Zone heating ====

* '''setPoint''': ''Number''.
* '''heatingMode''': ''String''.


==== Z-Wave Fan mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Z-Wave Thermostat mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== Command options (delay, duration, event triggering) ===

Many dzVents device methods support extra options, like controlling a delay or a duration:

<syntaxhighlight lang="lua">
-- switch on for 2 minutes after 10 seconds
device.switchOn().afterSec(10).forMin(2)

-- switch on at a specic time / day
device.switchOn().at('09:00') -- earliest moment it will be 09:00 hr.
device.switchOn().at('08:53:30 on fri') -- earliest moment it will be Friday at 08:53:30
device.switchOn().at('08:53:30 on sat, sun') -- earliest moment it will be Saturday or Sunday at 08:53:30 (whatever comes first)

-- switch on for 2 minutes after a randomized delay of 1-10 minutes
device.switchOff().withinMin(10).forMin(2)
device.close().forMin(15)
device.open().afterSec(20)
device.open().afterMin(2)

-- switch on but do not trigger follow up events
device.switchOn().silent()

-- flash a light for 3 times
device.switchOn().forSec(2).repeatAfterSec(1, 3)

-- switch the device on but only if the current state isn't already on:
device.switchOn().checkFirst()
-- this is a short for:
if (device.state == 'Off') then
devices.switchOn()
end</syntaxhighlight>

==== Options ====

* '''at(hh:mm[:ss][ on [ ddd|dddd ] )''': ''Function''.3.0.1 Activates the command at a certain time [ on a certain day]
* '''afterHour(hours), afterMin(minutes), afterSec(seconds)''': ''Function''. Activates the command after a certain number of hours, minutes or seconds.
* '''cancelQueuedCommands()''': ''Function''. Cancels queued commands. E.g. you switch on a device after 10 minutes: <code>myDevice.switchOn().afterMin(10)</code>. Within those 10 minutes you can cancel that command by calling: <code>myDevice.cancelQueuedCommands()</code>.
* '''checkFirst()''': ''Function''. Checks if the '''current''' state of the device is different than the desired new state. If the target state is the same, no command is sent. If you do <code>mySwitch.switchOn().checkFirst()</code>, then no switch command is sent if the switch is already on. This command only works with switch-like devices. It is not available for toggle and dim commands, either.
* '''forHour(hours), forMin(minutes), forSec(seconds)''': ''Function''. Activates the command for the duration of hours, minutes or seconds. See table below for applicability and the warning on unexpected behavior of these functions.
* '''withinHour(hours), withinMin(minutes), withinSec(seconds)''': ''Function''. Activates the command within a certain period (specified in hours, minutes or seconds) ''randomly''. See table below for applicability.
* '''silent()''': ''Function''. No follow-up events will be triggered: <code>mySwitch.switchOff().silent()</code>.
* '''repeatAfterHour(hours, [number]), repeatAfterMin(minutes, [number]), repeatAfterSec(seconds, [number])''': ''Function''. Repeats the sequence ''number'' times after the specified duration (specified in hours, minutes, or seconds). If no ''number'' is provided, 1 is used. '''Note that <code>afterAAA()</code> and <code>withinAAA()</code> are only applied at the beginning of the sequence and not between the repeats!'''

Note that the actual switching or changing of the device is done by Domoticz and not by dzVents. dzVents only tells Domoticz what to do; if the options are not carried out as expected, this is likely a Domoticz or hardware issue.

'''Important note when using forAAA()''': Let’s say you have a light that is triggered by a motion detector. Currently the light is <code>Off</code> and you do this: <code>light.switchOn().forMin(5)</code>. What happens inside Domoticz is this: at t0 Domoticz issues the <code>switchOn()</code> command and schedules a command to restore the '''current''' state at t5 which is <code>Off</code>. So at t5 it will switch the light off.

If, however, ''before the scheduled <code>switchOff()</code> happens at t5'', new motion is detected and you send this command again at t2 then something unpredictable may seem to happen: ''the light is never turned off!'' This is what happens:

At t2 Domoticz receives the <code>switchOn().forMin(5)</code> command again. It sees a scheduled command at t5 and deletes that command (it is within the new interval). Then Domoticz performs the (unnecessary, it’s already on) <code>switchOn()</code> command. Then it checks the current state of the light which is <code>On</code>!! and schedules a command to return to that state at t2+5=t7. So, at t7 the light is switched on again. And there you have it: the light is not switched off and never will be because future commands will always be checked against the current on-state.

That’s just how it works and you will have to deal with it in your script. So, instead of simply re-issuing <code>switchOn().forMin(5)</code> you have to check the switch’s state first:

<syntaxhighlight lang="lua">if (light.active) then
light.switchOff().afterMin(5)
else
light.switchOn().forMin(5)
end</syntaxhighlight>
or issue these two commands ''both'' as they are mutually exclusive:

<syntaxhighlight lang="lua">light.switchOff().checkFirst().afterMin(5)
light.switchOn().checkFirst().forMin(5)</syntaxhighlight>

==== Availability ====

Some options are not available to all commands. All the options are available to device switch-like commands like <code>myDevice.switchOff()</code>, <code>myGroup.switchOn()</code> or <code>myBlinds.open()</code>. For updating (usually Dummy ) devices like a text device <code>myTextDevice.updateText('zork')</code> you can only use <code>silent()</code>. For thermostat setpoint devices and snapshot command silent() is not available. For commands for which dzVents must use openURL, only <code>at()</code> and <code>afterAAA()</code> methods are available. These commands are mainly the setAaaaa() commands for RGBW type devices.

See table below

{| class="wikitable"
!width="17%"| option
!align="center" width="10%"| state changes
!align="center" width="11%"| update commands
!align="center" width="12%"| user variables
!align="center" width="12%"| updateSetpoint
!align="center" width="8%"| snapshot
!align="center" width="10%"| triggerIFTTT
!align="center" width="12%"| execute ShellCommand
!align="center" width="12%"| emitEvent
|-
| <code>afterAAA()</code>1
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>at()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>forAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>withinAAA()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| •
|-
| <code>silent()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>repeatAfterAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>checkFirst()</code>
|align="center"| • 2
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>cancelQueuedCommands()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a

|}

==== Notes on table ====

* '''Note 1''': AAA is a placeholder for <code>Min/Sec/Hour</code> affix e.g. <code>afterMin()</code>.
* '''Note 2''': for <code>domoticz.openURL()</code> only <code>at()</code>, <code>afterAAA()</code> and <code>withinAAA()</code> is available.
* '''Note 3''': Note 2 also applies for all commands depending on openURL (like rgbwwDevice.setAaa() commands).
* '''Note 4''': Including dimTo, switchSelector, setLevel and similar methods.


==== Follow-up event triggers ====

Normally if you issue a command, Domoticz will immediately trigger follow-up events, and dzVents will automatically trigger defined event scripts. If you trigger a scene, all devices in that scene will issue a change event. If you have event triggers for these devices, they will be executed by dzVents. If you don’t want this to happen, add <code>.silent()</code> to your commands (exception is updateSetPoint).


=== Create your own device adapter ===

If your device is not recognized by dzVents, you can still operate it using the generic device attributes and methods. It is much nicer, however, to have device specific attributes and methods. Existing recognized adapters are in <code>/path/to/domoticz/dzVents/runtime/device-adapters</code>. Copy an existing adapter and adapt it to your needs. You can turn debug logging on and inspect the file <code>domoticzData.lua</code> in the dzVents folder. There you will find the unique signature for your device type. Usually it is a combination of deviceType and deviceSubType, but you can use any of the device attributes in the <code>matches</code> function. The matches function checks if the device type is suitable for your adapter and the <code>process</code> function actually creates your specific attributes and methods. Also, if you call <code>myDevice.dump()</code> you will see all attributes and methods and the attribute <code>_adapters</code> shows you a list of applied adapters for that device. Finally, register your adapter in <code>Adapters.lua</code>. Please share your adapter when it is ready and working.

'''Note''': dzVents only runs when there is at least one active dzVents script, either created in the internal web editor or placed as a <code>.lua</code> file in <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Without such a script, Domoticz never starts the dzVents Lua engine, so the device adapters are not loaded, <code>domoticzData.lua</code> is not written and any logging you add to your adapter stays silent whatever the log level is. When you develop an adapter before you have a script that uses it, add a minimal placeholder script to activate the engine.


== Variable object API (user variables) ==

User variables created in Domoticz have these attributes and methods:


=== Variable attributes and methods ===

* '''changed''': ''Boolean''. Was the variable updated. '''Note''': update does not necessarily means the variable value or type changed.
* '''date''': ''Date''. If type is domoticz.DATE. See lastUpdate for the sub-attributes.
* '''id''': ''Number''. Index of the variable.
* '''lastUpdate''': ''[[#Time_object|Time Object]]''
* '''name''': ''String''. Name of the variable
* '''rename(newName)''': ''Function''. Change current variable name to new variable name. (does not support timing options)
* '''set(value)''': Tells Domoticz to update the variable. Supports timing options. See [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|above]].
* '''time''': ''Date''. If type is domoticz.TIME. See lastUpdate for the sub-attributes.
* '''type''': ''String''. Can be domoticz.INTEGER, domoticz.FLOAT, domoticz.STRING, domoticz.DATE, domoticz.TIME.
* '''value''': ''String|Number|Date|Time''. Value of the variable.

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
end
end
}</syntaxhighlight>

== Time object ==

Many attributes represent a moment in time, like <code>myDevice.lastUpdate</code> or <code>domoticz.time</code>. In dzVents, a time-like attribute is an object with properties and methods which make your life easier.

<syntaxhighlight lang="lua"> print(myDevice.lastUpdate.minutesAgo)
print(myDevice.lastUpdate.daysAgo)

-- compare two times
print(domoticz.time.compare(myDevice.lastUpdate).secs))</syntaxhighlight>
You can also create your own:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00') -- must be this format!!</syntaxhighlight>
If you don’t pass a time string:

<syntaxhighlight lang="lua"> local Time = require('Time')
local currentTime = Time()</syntaxhighlight>
Use this in combination with the various dzVents time attributes:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00')

local tonight = Time(domoticz.time.rawDate .. ' 20:00:00')
print (tonight.getISO())
-- will print something like: 2016-12-12T20:00:00Z
print(t.minutesAgo) -- difference from 'now' in minutes

-- and you can feed it with all same rules as you use
-- for the timer = { .. } section:
if (t.matchesRule('at 16:00-21:00')) then
-- t is in between 16:00 and 21:00
end

-- very powerful if you want to compare two time instances:
local anotherTime = Time('...') -- fill-in some time here
print(t.compare(anotherTime).secs) -- diff in seconds between t and anotherTime.</syntaxhighlight>

=== System event API ===

If you have a dzVents script that is triggered by a system-event in Domoticz then the second parameter passed to the execute function will be a ''system'' object. The object.type = system-event that triggered the script. ( object.isSystemEvent: true) For backups the object also contains location and durationin seconds.


=== Time properties and methods ===

Creation:

<syntaxhighlight lang="lua">local Time = require('Time')
local now = Time() -- current time
local someTime = Time('2017-12-31 22:19:15')
local utcTime = Time('2017-12-31 22:19:15', true)</syntaxhighlight>
Creation:

<syntaxhighlight lang="lua">local someTime = domoticz.time.addMinutes(30) -- someTime = domoticz time object for now + 30 minutes
local someTime = domoticz.time.makeTime() -- someTime = new domoticz time object.</syntaxhighlight>
* '''addAAA(offset)''': ''time object''. time object with given offset (positive or negative. AAA is a placeholder for <code>Seconds, Minutes, Hours or Days</code> affix e.g. `addHours(-2)
* '''civTwilightEndInMinutes''': ''Number''. Minutes from midnight until civTwilightEnd.
* '''civTwilightStartInMinutes''':''Number''. Minutes from midnight until civTwilightStart.
* '''compare(time)''': ''Function''. Compares the current time object with another time object. ''Make sure you pass a Time object!'' Returns a table (all values are ''positive'', use the compare property to see if ''time'' is in the past or future):
** '''milliseconds''': Total difference in milliseconds.
** '''seconds''': Total difference in whole seconds.
** '''minutes''': Total difference in whole minutes.
** '''hours''': Total difference in whole hours.
** '''days''': Total difference in whole days.
** '''compare''': 0 = both are equal, 1 = ''time'' is in the future, -1 = ''time'' is in the past.
* '''dateToDate( dateString, sourceFormat, targetFormat[ , offSet] )''':3.0.17 ''Function'': Returns a reformatted datestring. dateString is a formatted date and source- and targetFormat are representations of the dateString elements and their locations in the string (see examples in dateToTimestamp) . Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'dddd dd mmmm hh:MM:ss', 1 ) -- > 'Friday 31 December 23:31:06'
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'ddd dd mmm hh:MM:ss', -3600 * 24 - 3 )) -- > 'Thu 30 Dec 23:31:02'</syntaxhighlight>
* '''dateToTimestamp([ dateString [,control] ] )''': ''Function'': Returns ''Number'' representing time since epoch in seconds. dateString is a formatted date and control is a representation of the dateString elements and their location in the string. Default control is ‘yyyy-mm-dd hh:MM’. recognized controls are either a Lua pattern string or a string containing following codes:

<syntaxhighlight lang="lua"> dddd -- full weekdayname(e.g. Wednesday) language depends on locale
ddd -- abbreviated weekdayname(e.g. Wed) language depends on locale
dd -- day of the month {[01-31]
mmmm -- full monthname(e.g September) language depends on locale
mmm -- abbreviated monthname(e.g. Sep) language depends on locale
mm -- month [01-12]
yyyy -- 4 digit year
yy -- 2 digit year
hh -- hour 24-hour clock
ii -- hour 12-hour clock
MM -- minute
ss -- second
W -- weeknumber [01-53]
w -- weekday{[0-6] Sunday-Saturday
datm -- date and time (e.g. 09/16/98 23:48:10) format depends on locale
mer -- either "AM" or "PM" locale
date -- date(e.g. 09/16/98) format depends on locale
time -- time (e.g. 23:48:10)

-- examples:
domoticz.time.dateToTimestamp('2020-12-31 23:59')) -- > 1609455540
domoticz.time.dateToTimestamp('2020-12-31 23:59:01','yyyy-mm-dd hh:MM:ss')) -- > 1609455541
domoticz.time.dateToTimestamp('December 31, 23:59:02','mmmm dd, hh:MM:ss')) -- > 1609455542
domoticz.time.dateToTimestamp('2020-12-31 23:59:03','(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)' )) -- > 1609455543
domoticz.time.dateToTimestamp('20201231235904','(%d%d%d%d)(%d%d)(%d%d)(%d%d)(%d%d)(%d%d)')) -- > 1609455544</syntaxhighlight>
* '''day''': ''Number''
* '''dayAbbrOfWeek''': ''String''. sun,mon,tue,wed,thu,fri or sat
* '''daysAgo''': ''Number''
* '''dayName''': ''String''. complete name Sunday, Monday, etc
* '''dDate''': ''Number''. timestamp (seconds since 01/01/1970 00:00)
* '''getISO''': ''Function''. Returns the ISO 8601 formatted date.
* '''hour''': ''Number''
* '''hoursAgo''': ''Number''. Number of hours since the last update.
* '''isdst''': ''Boolean''. 3.0.18 Indicates if time is in the daylight saving period
* '''isToday''': ''Boolean''. Indicates if time is today
* '''isUTC''': ''Boolean''.
* '''makeTime(string | table,[isUTC])''': ''domoticz time object''. returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. isUTC defaults to false.
* '''matchesRule(rule) ''': ''Function''. Returns true if the rule matches with the time. See [[#timer_trigger_rules|time trigger rules]] for rule examples.
* '''millisecondsAgo''': ''Number''. Number of milliseconds since the last update.
* '''minutes''': ''Number''
* '''minutesAgo''': ''Number''. Number of minutes since the last update.
* '''minutesSinceMidnight''': ''Number''
* '''month''': ''Number''
* '''monthAbbrName''': String. jan, feb, mar, etc
* '''monthName''': ''String''. January, February, etc
* '''msAgo''': ''Number''. Number of milliseconds since the last update.
* '''raw''': ''String''. Generated by Domoticz
* '''rawDate''': ''String''. Returns the date part of the raw data.
* '''rawDateTime''': ''String''. Combined date / time formatted as domoticz does in API / JSON returns (rawDate .. ’ ’.. rawTime )
* '''rawTime''': ''String''. Returns the time part of the raw data as HH:MM:SS
* '''seconds''': ''Number''
* '''secondsSinceMidnight''': ''Number''
* '''secondsAgo''': ''Number''. Number of seconds since the last update.
* '''sunsetInMinutes''': ''Number''. Minutes from midnight until sunset.
* '''sunriseInMinutes''': ''Number''. Minutes from midnight until sunrise.
* '''solarnoonInMinutes''': ''Number''. 3.0.11 Minutes from midnight until solarnoon.
* '''time''': ''String''. Returns the time part of the raw data as HH:MM
* '''timestampToDate([ [ timestamp ] , [ pattern ] ,[ offSet ] )''': ''function''. Returns a datestring. timestamp is number of seconds since epoch (default = now) , pattern is a string as explained in this wiki at the description of the domoticz.time.dateToTimestamp function (default = ‘yyyy-mm-dd hh:MM:ss’). Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.timestampToDate(10,'date time') --> '01/01/70 01:00:10'
domoticz.time.timestampToDate(60,'ddd mm mmm yyyy ii:MM mer','date time') --> 'Thu 01 Jan 1970 01:01 AM''
domoticz.time.timestampToDate(1598077445,'dd/mm/yy ii:MM mer nZero') --> '22/08/20 8:24 AM'</syntaxhighlight>
* '''toUTC(string | table,[offset])''': ''domoticz time object''. 3.0.9 returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. offset defaults to 0.
* '''utcSystemTime''': ''Table''. UTC system time (only when in UTC mode):
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''utcTime''': ''Table''. Time stamp in UTC time:
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''year''': ''Number''
* '''wday''': ''Number'' day of the week. Sunday = 1, Saturday = 7
* '''week''': ''Number'' week of the year

'''Note: it is currently not possible to change the domoticz.time object instance.''' ( but you can create a new one with- or without an offset)


== Shared helper functions ==

It is not unlikely that at some point you want to share Lua code among your scripts. Normally in Lua you would have to create a module and require that module in all you scripts. But dzVents makes that easier for you: Inside your scripts folder or in Domoticz’ GUI web editor, create a <code>global_data.lua</code> script (same as for global persistent data) and feed it with this code:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(param1, param2)
-- do your stuff
end,
MY_CONSTANT = 100 -- doesn't have to be a function
}
}</syntaxhighlight>
Save the file and then you can use myHandyFunction everywhere in your event scripts:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction('bla', 'boo')
print(domoticz.helpers.MY_CONSTANT)
end
}</syntaxhighlight>
No <code>require</code> or <code>dofile</code> is needed.

'''Important note: if you need to access the domoticz object in your helper function you have to pass it as a parameter:'''

Example:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(domoticz, param1, param2)
-- do your stuff
domoticz.log('Hey')
end
}
}</syntaxhighlight>
And pass it along:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction(domoticz, 'bla', 'boo')
end
}</syntaxhighlight>
'''Note''': there can be only '''one''' <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.


== Requiring your own modules ==

If you don’t want to use the helpers support, but you want to require your own modules, place them either in <code>/path/to/domoticz/scripts/dzVents/modules</code> or <code>/path/to/domoticz/scripts/dzVents/scripts/modules</code> as these folders are already added to the Lua package path. You can just require those modules: <code>local myModule = require('myModule')</code>


= Persistent data =

In many situations you need to store a device state or other information in your scripts for later use. Like knowing what the state was of a device the previous time the script was executed or what the temperature in a room was 10 minutes ago. Without dzVents, you had to resort to user variables. These are global variables that you create in the Domoticz GUI and that you can access in your scripts like: domoticz.variables(‘previousTemperature’).

Now, for some this is rather inconvenient and they want to control this state information in the event scripts themselves or want to use all of Lua’s variable types. dzVents has a solution for that: '''persistent script data'''. This can either be on the script level or on a global level.


== Script level persistent variables ==

The values in persistent script variables persist and can be retrieved in the next script run.

For example, send a notification if a switch has been activated 5 times:

<syntaxhighlight lang="lua"> return {
on = {
devices = { 'MySwitch' }
},
data = {
counter = { initial = 0 }
},
execute = function(domoticz, switch)
if (domoticz.data.counter == 5) then
domoticz.notify('The switch was pressed 5 times!')
domoticz.data.counter = 0 -- reset the counter
else
domoticz.data.counter = domoticz.data.counter + 1
end
end
}</syntaxhighlight>
The <code>data</code> section defines a persistent variable called <code>counter</code>. It also defines an initial value. From then on you can read and set the variable in your script.

You do not have to provide an initial value though. In that case the initial value is ''nil'':

<syntaxhighlight lang="lua"> return {
--
data = {
'x', 'y', 'z' -- note the quotes
},
execute = function(domoticz, item)
print(tostring(domoticz.data.x)) -- prints nil
end
}</syntaxhighlight>
You can define as many variables as you like and put whatever value in there that you like. It doesn’t have to be just a number. Just don’t put something in there with functions (well, they are filtered out actually).


=== Size matters and watch your speed!! ===

If you include tables (or arrays) in the persistent data, beware to not let them grow. It will definitely slow down script execution because dzVents has to serialize and deserialize the data. It is better to use the historical option as described below.


=== Re-initializing a variable ===

You can re-initialize a persistent variable and re-apply the initial value as defined in the data section:

<syntaxhighlight lang="lua">return {
on = { .. },
data = {
x = { initial = 'initial value' }
},
execute = function(domoticz, item)
if (domoticz.data.x ~= 'initial value') then
domoticz.data.initialize('x')
print(domoticz.data.x) -- will print 'initial value'
end
end
}</syntaxhighlight>
Note that <code>domoticz.data.initialize('<varname>')</code> is just a convenience method. You can of course create a local variable in your module holding the initial value and use it in your data section and your execute function.


== Global persistent variables ==

Script level variables are only available in the scripts that define them, but global variables can be accessed and changed in every script. To utilize global persistent variables, create a script file called <code>global_data.lua</code> in your scripts folder with this content (same file where you can also put your shared helper functions):

<syntaxhighlight lang="lua"> return {
helpers = {},
data = {
peopleAtHome = { initial = false },
heatingProgramActive = { initial = false }
}
}</syntaxhighlight>
Just define the variables that you need and access them in your scripts:

<syntaxhighlight lang="lua"> return {
on = {
devices = {'WindowSensor'}
},
execute = function(domoticz, windowSensor)
if (domoticz.globalData.heatingProgramActive
and windowSensor.state == 'Open') then
domoticz.notify("Hey don't open the window when the heating is on!")
end
end
}</syntaxhighlight>
'''Note''': there can be only one <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.

You can use <code>domoticz.globalData.initialize('<varname>')</code> just as like <code>domoticz.data.initialize('<varname>')</code>.


== A special kind of persistent variables: ''history = true'' (Historical variables API) ==

In some situations, storing a previous value for a sensor is not enough, and you would like to have more previous values. For example, you want to calculate an average over several readings. Of course you can define a persistent variable holding a table:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
previousData = { initial = {} }
},
execute = function(domoticz, sensor)
-- add new data
table.insert(domoticz.data.previousData, sensor.temperature)

-- calculate the average
local sum = 0, count = 0
for i, temp in pairs(domoticz.data.previousData) do
sum = sum + temp
count = count + 1
end
local average = sum / count
end
}</syntaxhighlight>
The problem with this is that you have to do a lot of bookkeeping to make sure that there isn’t too much data to store (see [[#How_does_the_storage_stuff_work.3F|below for how it works]]) . Fortunately, dzVents has done this for you:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
temperatures = { history = true, maxItems = 10 }
},
execute = function(domoticz, sensor)
-- add new data
domoticz.data.temperatures.add(sensor.temperature)

-- average
local average = domoticz.data.temperatures.avg()

-- maximum value in the past hour:
local max = domoticz.data.temperatures.maxSince('01:00:00')
end
}</syntaxhighlight>

=== Defining ===

Define a script variable or global variable in the data section and set <code>history = true</code>:

<syntaxhighlight lang="lua"> …
data = {
var1 = { history = true, maxItems = 10, maxHours = 1, maxMinutes = 5 }
}</syntaxhighlight>
* '''maxItems''': ''Number''. Controls how many items are stored in the variable. maxItems has precedence over maxHours and maxMinutes.
* '''maxHours''': ''Number''. Data older than <code>maxHours</code> from now will be discarded. E.g., if set to 2, then data older than 2 hours will be removed at the beginning of the script.
* '''maxMinutes''': ''Number''. Same as maxHours but, you guessed it: for minutes this time.. All these options can be combined. '''Reminder: don’t store too much data. Only put in what you really need!'''


=== Adding data ===

Add new values to a historical variable:

<pre>domoticz.data.myVar.add(value)</pre>
As soon as this new value is put on top of the list, the older values shift one place down the line. If <code>maxItems</code> is reached, then the oldest value will be discarded. ''All methods, like calculating averages or sums, will immediately use this new value!'' If you don’t want this to happen, set the new value at the end of your script or after you have done your analysis.

Any kind of data may be stored in the historical variable: numbers, strings, but also more complex data like tables. However, in order to use the [[#Statistical_functions|statistical methods]], numeric values are required.


=== Accessing values in historical variables ===

Values in a historical variable are indexed, where index 1 is the newest value, 2 is the second newest, and so on:

<pre>local item = domoticz.data.myVar.get(5)
print(item.data)</pre>
However, all data in the storage are time-stamped:

<pre>local item = domoticz.data.myVar.getLatest()
print(item.time.secondsAgo) -- access the time stamp
print(item.data) -- access the data</pre>
The time attribute by itself is a table with many properties that help you inspect the data points more easily. See [[#Time_object|Time Object]] for all attributes and methods.


==== Index ====

All data in the set can be addressed using an index. The item with index = 1 is the youngest, and the item with the highest index is the oldest. Beware, if you have called <code>add()</code> first, then the first item is that new value! You can always check the size of the set by inspecting <code>myVar.size</code>.


==== Time specification (''timeAgo'') ====

Every data point in the set has a timestamp and the set is ordered so that the youngest item is the first and the oldest item the last. Many functions require a moment in the past to be specified by passing a string in the format '''<code>hh:mm:ss</code>''', where ''hh'' is the number of hours ago, ''mm'' the number of minutes and ''ss'' the number of seconds. The times are added together, so you don’t have to consider 60 minute boundaries, etc. A time specification of <code>12:88:03</code> is valid, and points to the data point at or around <code>12*3600 + 88*60 + 3 = 48.483 seconds</code> in the past.

Example:

<pre>-- get average for the past 30 minutes:
local avg = myVar.avgSince('00:30:00')</pre>

==== Getting data points ====

* '''get(idx)''': Returns the idx-th item in the set. Same as <code>myVar.storage[idx]</code>.
* '''getAtTime([[#Time_specification_.28timeAgo.29|timeAgo]])''': Returns the data point ''closest'' to the moment as specified by <code>timeAgo</code> and the index in the set. So, <code>myVar.getAtTime('1:00:00')</code> returns the item that is closest to one hour old. It may be a bit younger or a bit older than 1 hour. The second return value is the index in the set: <code>local item, index = myVar.getAtTime('1:00:00')</code>
* '''getLatest( )''': Returns the youngest item in the set. Same as <code>print(myVar.get(1).data)</code>.
* '''getOldest( )''': Returns the oldest item in the set and the index. Same as <code>print(myVar.get(myVar.size).data)</code>. Note that the index is always the same as the total size. <code>local item, index = myVar.getOldest()</code>.
* '''size''': Return the number of data points in the set.
* '''subset( [fromIdx], [toIdx] )''': Returns a subset of the stored data. Default value, if omitted, of <code>fromIdx</code> is 1. Omitting <code>toIdx</code> takes all items until the end of the set (oldest). E.g., <code>myVar.subset()</code> returns all data. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''subsetSince( [[#Time_specification_.28timeAgo.29|timeAgo]] )''': Returns a subset of the stored data since the relative time specified by timeAgo. So calling <code>myVar.subsetSince('00:60:00')</code> returns all items that have been added to the list in the past 60 minutes. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''reset( )''': Removes all the items from the set. It could be a good practice to do this often when you know you don’t need older data. For instance, when you turn on a heater and you just want to monitor rising temperatures starting from this moment when the heater is activated. If you don’t need data points from before, then you may call reset.


==== Looping through the data: iterators ====

Similar to the iterators as described [[#Looping_through_the_collections:_iterators|above]], there are convenience methods to make looping through the data set easier.

* '''forEach(function)''': Loop over all items in the set: E.g.: <code>myVar.forEach( function( item, index, collection) ... end )</code>
* '''filter(function)''': Create a filtered set of items. The function receives the item and returns true if the item is in the result set. E.g. get a set with item values larger than 20: <code>subset = myVar.filter( function (item) return (item.data > 20) end )</code>.
* '''find(function)''': Search for a specific item in the set: E.g. find the first item with a value higher than 20: <code>local item = myVar.find( function (item) return (item.data > 20) end )</code>.
* '''reduce(function, initial)''': Loop over all items in the set and do some calculation with it. You call reduce with the function and the initial value. Each iteration the function is called with the accumulator. The function does something with the accumulator and returns a new value for it. Once you get the hang of it, it is very powerful. Best to give an example. To sum all values:

<syntaxhighlight lang="lua"> local sum = myVar.reduce(function(acc, item)
local value = item.data
return acc + value
end, 0)</syntaxhighlight>
Suppose you want to get data points older than 45 minutes and count the values that are higher than 20 (of course there are more ways to do this):

<syntaxhighlight lang="lua"> local myVar = domoticz.data.myVar

local olderItems = myVar.filter(function (item)
return (item.time.minutesAgo > 45)
end)

local count = olderItems.reduce(function(acc, item)
if (item.data > 20) then
acc = acc + 1
end
return acc
end, 0)

print('Found ' .. tostring(count) .. ' items')</syntaxhighlight>

==== Statistical functions ====

Statistical functions require ''numerical'' data in the set. If the set is just numbers you can do this:

<pre>myVar.add(myDevice.temperature) -- adds a number to the set
myVar.avg() -- returns the average</pre>
If, however, you add more complex data or you want to do a computation first, then you have to ''tell dzVents how to get a numeric value from these data''. So let’s say you do this to add data to the set:

<pre>myVar.add( { 'person' = 'John', waterUsage = u })</pre>
Where <code>u</code> is a variable that got its value earlier. If you want to calculate the average water usage, then dzVents will not be able to do this because it doesn’t know the value is actually in the <code>waterUsage</code> attribute! You will get <code>nil</code>.

To make this work you have to provide a '''getValue function''' in the data section when you define the historical variable:

<syntaxhighlight lang="lua"> return {
active = true,
on = {...},
data = {
myVar = {
history = true,
maxItems = 10,
getValue = function(item)
return item.data.waterUsage -- return number!!
end
}
},
execute = function()...end
}</syntaxhighlight>
This function tells dzVents how to get the numeric value for a data item. '''Note: the <code>getValue</code> function has to return a number!'''.

Of course, if you don’t intend to use any of these statistical functions you can put whatever you want in the set.

<ul>
<li>'''avg( [fromIdx], [toIdx], [default] )''': Calculates the average of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''avgSince([[#Time_specification_.28timeAgo.29|timeAgo]], default )''': Calculates the average of all data points since <code>timeAgo</code>. Returns <code>default</code> if there are no data, otherwise 0. E.g.: <code>local avg = myVar.avgSince('00:30:00')</code> returns the average over the past 30 minutes.</li>
<li>'''med( [fromIdx], [toIdx], [default] )''': Calculates the median of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''min( [fromIdx], [toIdx] )''': Returns the lowest value in the range defined by fromIdx and toIdx.</li>
<li>'''minSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''min''' but now within the <code>timeAgo</code> interval.</li>
<li>'''max( [fromIdx], [toIdx] )''': Returns the highest value in the range defined by fromIdx and toIdx.</li>
<li>'''maxSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''max''' but within the <code>timeAgo</code> interval.</li>
<li>'''sum( [fromIdx], [toIdx] )''': Returns the summation of all values in the range defined by fromIdx and toIdx. It will return 0 when there are no data.</li>
<li>'''sumSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''sum''' but within the <code>timeAgo</code> interval. It will return 0 when there are no data in the interval.</li>
<li>** delta(fromIdx, toIdx, [smoothRange], [default] )**: Returns the delta (difference) between items specified by <code>fromIdx</code> and <code>toIdx</code>. Provide a valid range (no <code>nil</code> values). [Supports data smoothing]. (#Data_smoothing) when providing a <code>smoothRange</code> value. Returns <code>default</code> if there is not enough data. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta(2, 5, 3)</code>.</li>
<li>'''delta2( fromIdx, toIdx, [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''delta''' but now you can control if the smooth values for the ''from-item'' and the ''to-item'' separately. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta2(2, 5, 3, 3)</code>.</li>
<li>'''deltaSince([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRange], [default] )''': Same as '''delta''' but within the <code>timeAgo</code> interval. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSince('00:00:10', 3)</code>.</li>
<li>'''deltaSinceOrOldest([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''deltaSince''' but it will take the oldest value in the set if ''timeAgo'' is older than the age of the entire set. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSinceOrOldest('00:00:10', 3, 3)</code>.</li>
<li>'''localMin( [smoothRange], default )''':</li>
<li>'''localMin( [smoothRange], default )''': Returns the first minimum value (and the item holding the minimal value) in the past. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value. For example, given this range of values in the data set (from new to old): <code>10 8 7 5 3 4 5 6</code>, it will return <code>3</code> because older values ''and'' newer values are higher: a local minimum. Use this if you want to know at what time a temperature started to rise after it had been dropping. E.g.:
<pre> local value, item = myVar.localMin()
print(' minimum was : ' .. value .. ': ' .. item.time.secondsAgo .. ' seconds ago' )</pre></li>
<li>'''localMax([smoothRange], default)''': Same as '''localMin''' but for the maximum value. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value.</li>
<li>'''smoothItem(itemIdx, [smoothRange])''': Returns a the value of <code>itemIdx</code> in the set but smoothed by averaging with its neighbors. The number of neighbors is set by <code>smoothRange</code>. See [[#Data_smoothing|Data smoothing]].</li></ul>


==== Data smoothing ====

Example: Suppose you store temperatures in the historical variable. These temperatures may have extremes. Perhaps these extremes could be due to sensor reading errors. In order to reduce the effect of these so-called spikes, you could smooth out values. It is like blurring the data. The Raw column is your temperatures. The other columns are calculated by averaging the neighbors. For item 10 the calculations are:

<pre>Range=1 for time10 = (25 + 31 + 29) / 3 = 28,3
Range=2 for time10 = (16 + 25 + 31 + 29 + 26) / 5 = 25,4</pre>

{| class="wikitable" style="text-align: center; align="center" width="30% height:10px;"
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"| time
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| raw
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=1
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=2
|-
| '''1'''
| 18
| 20,0
| 21,7
|-
| '''2'''
| 22
| 21,7
| 25,0
|-
| '''3'''
| 25
| 27,3
| 24,6
|-
| '''4'''
| 35
| 27,7
| 26,6
|-
| '''5'''
| 23
| 28,7
| 27,6
|-
| '''6'''
| 28
| 26,0
| 25,8
|-
| '''7'''
| 27
| 23,7
| 23,8
|-
| '''8'''
| 16
| 22,7
| 25,4
|-
| '''9'''
| 25
| 24,0
| 25,6
|-
| '''10'''
| 31
| 28,3
| 25,4
|-
| '''11'''
| 29
| 28,7
| 29,2
|-
| '''12'''
| 26
| 30,0
| 30,2
|-
| '''13'''
| 35
| 30,3
| 30,2
|-
| '''14'''
| 30
| 32,0
| 30,4
|-
| '''15'''
| 31
| 30,3
| 30,8
|-
| '''16'''
| 30
| 29,7
| 28,2
|-
| '''17'''
| 28
| 26,7
| 28,6
|-
| '''18'''
| 22
| 27,3
| 26,2
|-
| '''19'''
| 32
| 24,3
| 25,3
|-
| '''20'''
| 19
| 25,5
| 24,3
|}
A chart illustrates it more clearly. The red line is not smoothed and has more spikes than the others:

[[File:dzvents-smoothing.png|frame|none|alt=|Smoothing]]

Usually a range of 1 or 2 is sufficient when providing a smoothing range to statistical functions. I suggest smoothing when checking deltas, local minimums and maximums.


== How does the storage stuff work? ==

For every script file that defines persisted variables (using the <code>data={ … }</code> section), dzVents will create storage file with the name <code>__data_scriptname.lua</code> in a subfolder called <code>data</code>. You can always delete these data files or the entire storage folder if there is a problem with it:

<pre>domoticz/
scripts/
dzVents/
data/
__data_yourscript1.lua
__data_yourscript2.lua
__data_global_data.lua
examples/
generated_scripts/
scripts/
yourscript1.lua
yourscript2.lua
global_data.lua</pre>
If you dare to, you can watch inside these files. Every time some data are changed, dzVents will stream the changes back into the data files. '''Again, make sure you don’t put too much stuff in your persistent data as it may slow things down too much.'''


= Asynchronous HTTP requests =

dzVents allows you to make asynchronous HTTP request and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use os functions like <code>curl</code> or <code>wget</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz will terminate the script with a message that it took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to make an http call and it is determined by how you use the <code>domoticz.openURL()</code> command. The simplest form simply calls <code>openURL</code> on the domoticz object with only the url as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.openURL('http://domain/path/to/something?withparameters=1')</syntaxhighlight>
After your script is finished, Domoticz will make the request that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a url you pass in a table with all the parameters to make the request '''and''' your provide a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.openURL({
url = 'http://domain/path/to/something',
method = 'POST',
callback = 'mycallbackstring',
postData = {
paramA = 'something',
paramB = 'something else'
}
})
end
}</syntaxhighlight>
In this case, Domoticz will make the request (a POST in this case), and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
httpResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if (response.ok) then -- success
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every 5 seconds'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = '...',
callback = 'trigger'
})
end
if (item.isHTTPResponse) then
if (item.ok) then
...
end
end
end
}</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.openURL(options)''': ''options'' is a Lua table:

* '''url''': ''String''.
* '''method''': ''String''. Optional. Either <code>'GET'</code> (default), <code>'POST'</code>, <code>'PUT'</code>3.0.2 or <code>'DELETE'</code>3.0.2 .
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to trigger the callback handler script(s).
* '''headers''': ''Table / String''. Optional. A Lua table or JSON string with additional http request-headers.
* '''postData''': ''Table / String''. Optional. When doing a <code>POST</code>, <code>PUT</code> 3.0.2 or <code>DELETE</code>3.0.2 this data will be the payload of the request (body). If you provide a Lua table then this will automatically be converted to json and the request-header <code>application/json</code> is set. So no need to do that manually. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': Raw response data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''headers''': ''Table''. Response headers.
* '''isJSON''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'application/json'</code>. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'text/xml'</code>. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be in range of 200-299.
* '''statusCode''': ''Number''. HTTP status codes. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''statusText''': ''String''. HTTP status message. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''protocol''': ''String''. HTTP protocol. See [https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP response status codes].
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


=== More about request and response headers ===

Whenever you do an http request it is not just some data that is sent. Along with the request a bunch of so-called headers are sent along with it. HTTP headers allow the client and the server to pass additional information with the request or the response. Also, in the response there are also headers (response header). These response headers usually tell you what kind of data is returned, if it is compressed, if the request was successful etc.


==== request headers ====

dzVents allow you to set custom request headers that will accompany the data in the request. Sometimes it is necessary to set these headers like for instance when a API or webservice require a security token or key or when the service needs to know what the format of the response data is. Check the documentation of the web service.

So, let’s say you need to call a web service that requires an api key in the headers and the documentation states it needs to be passed in an x-access-token header. Your openURL command then may look like this:

<syntaxhighlight lang="lua">domoticz.openURL({
url = 'https://somedomain.com/service/getInfo',
headers = { ['x-access-token'] = '<api-key>' },
method = 'GET',
callback = 'info'
})</syntaxhighlight>
Check google for more information about request headers. All you need to know here is that dzVents allow you to set these headers.


==== response headers ====

As said earlier, the response also contains a bunch of headers. You can inspect those headers with dzVents but ususally you don’t have to. For starters, dzVents already checks the <code>Content-Type</code> header which usually states what kind of data format the response is. If it is <code>application/json</code> then it automatically converts the json data to a Lua table. Also, it checks the <code>Status</code> header to see if the request was successful. If so, then it sets the <code>ok</code> attribute on the response object. So normally you don’t have to inspect the headers. However, sometimes the web service puts a session token in the response header that you have to use in follow-up requests.

So here an example where we have to log in before we can fetch data. It uses two requests: the first performs the log-in and the second grabs the session token from the login response data and uses that token in the second request to get the data we need. In this example we do this every hour.

That would look like this:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'loggedin', 'data' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/login',
method = 'POST',
postData = { ['username'] = 'Luke Skywalker', ['password'] = 'theforce' }
callback = 'loggedin'
})
end
if (item.isHTTPResponse and item.ok) then
-- check to which request this response was the result
if (item.trigger == 'loggedin') then
-- we are logged in, now grab the session token from the header and
-- fetch our data
local token = item.headers['x-session-token']
-- now we have the token, put it in the headers:
domoticz.openURL({
url = 'https://somedomain.com/getData',
method = 'GET',
headers = { ['x-session-token'] = token },
callback = 'data'
})
else
-- it must the data we requested
local data = item.data
-- do something with it
end
end
end
}</syntaxhighlight>
Some remarks about the response header <code>Content-Type</code>. If a service is a good web-citizen then it tells you what the format of the data is in this header. So, if the data is a json object then the header should be <code>application/json</code>. Unfortunately, there are lot of lazy programmers out there who don’t set this header properly. If that is the case, dzVents cannot detect the format and will not turn it into a Lua table for you automatically. So, if you know it is json but the header is not properly set, then you can easily convert it into a Lua table in your code:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/getData',
callback = 'trigger'
})
end
if (item.isHTTPResponse and item.ok) then
-- we know it is json but dzVents cannot detect this
-- convert to Lua
local json = domoticz.utils.fromJSON(item.data)
-- json is now a Lua table
print(json.result.title) -- just an example
end
end
}</syntaxhighlight>

= Asynchronous shell command execution =

dzVents allows you to make asynchronous shell commands and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use functions like <code>utils.osCommand()</code> or <code>os.Execute()</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz comes with a message that the script took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to execute a shell command asynchronously and it is determined by how you use the <code>domoticz.executeShellCommand()</code> command. The simplest form simply calls <code>executeShellCommand</code> on the domoticz object with only the command as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.executeShellCommand('some shell command')</syntaxhighlight>
After your script is finished, Domoticz will execute the request in a separate thread and that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a command you pass in a table with the command to be executed '''and''' a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.executeShellCommand({
command = 'some shell command',
callback = 'mycallbackstring',
timeout = timeoutinseconds,
})
end
}</syntaxhighlight>
In this case, Domoticz will execute the command and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
shellCommandResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if response.ok then
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every 5 minutes',
},
shellCommandResponses =
{
scriptVar,
},
},

execute = function(domoticz, item)
if item.isTimer then
domoticz.executeShellCommand(
{
command = 'some shell command',
callback = scriptVar,
timeout = timeoutinseconds,
})
elseif item.isShellCommandResponse then
if item.statusCode == 0 then
... -- process result (in item.json, -item.xml, -item.lines or item.data)
end
end
end
}
</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.executeShellCommand(options)''': ''options'' is a Lua table:

* '''command''': ''String''.
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to find a the callback handler script.
* '''timeout''': ''Integer''. Optional. Max execution time in seconds. defaults to 10 seconds. A value of 0 disables the timeout.

Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': output from the command. (stdout)
* '''errorText''': Errors generated by the command (stderr)
* '''statusCode''': ''Int''. exitcode generated by the command
* '''hasLines''': ''Boolean''. When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''json''': ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be 0.
* '''timeoutOccurred''' ''Boolean'' <code>True</code> when the request was aborted by a timeout.
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


= Settings =

Settings for dzVents are found in the Domoticz GUI: '''Setup > Settings > Other > EventSystem''':

* '''dzVents disabled''': Tick this if you don’t want any dzVents script to be executed.
* '''Log level''': (Note that you can override this setting in the logging section of your script)
** ''Errors'',
** ''Errors + minimal execution info'': Errors and some minimal information about which script is being executed and why,
** ''Errors + minimal execution info + generic info''. Even more information about script execution and a bit more log formatting.
** ''Debug''. Shows everything and dzVents will create the files <code>domoticzData.lua</code> and <code>module.log</code> in the scripts/dzVents folder. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz and <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.
** ''No logging''. As silent as possible.


= Troubleshooting =

So, you think if you have done everything correctly but things do not work (in some way) as you expected. Here are a couple steps you can do to find the cause.


=== Is dzVents enabled? ===

Check the settings (see above) and make sure the checkbox '''dzVents disabled''' is not checked.


=== Is your script enabled? ===

Make sure the active section in your script is set to <code>true</code>: <code>active = true</code>. And, on top of that, if you are using the internal web editor to write your script, make sure that your script is active there and you have clicked Save! “Event active” is a separate checkbox that must be ticked for every active script. When not active, the script name will be red in the list on the right.


=== Do you have at least one active script? ===

dzVents only starts its Lua engine when there is at least one active dzVents script, either created in the internal web editor or placed as a <code>.lua</code> file in <code>/path/to/domoticz/scripts/dzVents/scripts</code>. With no active script at all, Domoticz skips dzVents completely: nothing is logged whatever the log level is, <code>domoticzData.lua</code> and <code>module.log</code> are not created, and the code in the device adapters never runs. Adding a minimal script is enough to activate the engine.


=== Turn on debug logging ===

Activate debug logging in the settings (see above). This will produce a lot of extra messages in the Domoticz log (don’t forget to turn it off when you are done troubleshooting!). It is best to monitor the log through the command line, as the log in the browser sometimes tends to not always show all log messages. See the Domoticz manual for how to do that.

When debug logging is enabled, every time dzVents kicks into action (Domoticz throws an event) it will log it, and it will create the files <code>domoticzData.lua</code> and <code>module.log</code> in <code>/path/to/domoticz/scripts/dzVents</code>. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz. This data lie at the core of the dzVents object model. You can open this file in an editor to see if your device/variable/scene/group/hardware is in there. Note that the data in the file are not exactly the same as what you will get when you interact with dzVents, but it is a good start. If your object is not in the data file, then you will not have access to it in dzVents and dzVents will not be able to match triggers with that object. Something’s wrong if you expect your object to be in there but it is not (is the object active/used?). <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.with a dump of the data sent to dzVents.

Example content of <code>module.log</code>

<pre> Startdate time - End date time (clk - CPU ) dule / scriptname << type: "trigger"
---------------------------------------------------------------------------------------------------------------
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0029) waqi.lua << timer: "every 20 minutes"
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0016) Washer.lua << timer: "every 5 minutes"
11/27/20 18:40:01 - 11/27/20 18:40:01 (00 - 0.0215) getWaterFromHomewizard.lua << HTTPResponse: "WaterfromHomewizard"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.2472) updateWeatherSensors.lua << HTTPResponse: "WUS_buienradarResponse"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.0290) waqi.lua << HTTPResponse: "waqi_nearby"
11/27/20 18:41:00 - 11/27/20 18:41:00 (00 - 0.0583) Bathroom humidity.lua << timer: "every minute between 05:15 and 23:30"</pre>
Every time Domoticz starts dzVents and debug logging is enabled you should see these lines in the domoticz log:

<pre>dzVents version: x.y.z
Event trigger type: aaaa</pre>
Where aaaa can be time, custom event, system event, device, uservariable, security or scenegroup. That should give you a clue what kind of event is active. If you don’t see this information then dzVents is not active (or debug logging is not active).


=== Script is still not executed ===

If for some reason your script is not executed while all of the above is done, it is possible that your triggers are not correct. Either the time rule is not matching with the current time (try to set the rule to <code>every minute</code> or something simple), or the device name is not correct (check casing), or you use an id that doesn’t exist. Note that in the <code>on</code> section, you cannot use the dzVents domoticz object!

Make sure that if you use an id in the <code>on</code> section that this id is correct. Go to the device list in Domoticz and find the device and make sure the device is in the ‘used’ list!. Unused devices will not create an event. Find the idx for the device and use that as the id.

Also, make sure that your device names are unique! dzVents will throw a warning in the log if multiple device names match. It’s best practice to have unique names for your devices. Use some clever naming like prefixing like ‘Temperature: living room’ or ‘Lights: living room’. That also makes using wild cards on your <code>on</code> section easier.

If your script is still not triggered, you can try to create a classic Lua event script and see if that does work.


=== Debugging your script ===

A simple way to inspect a device in your script is to dump it to the log: <code>myDevice.dump()</code>. This will dump everything known to dzVents of the device so you can inspect what its state is. If you only need to see a subset you can use dumpSelection(‘attributes’), dumpSelection(‘functions’) or dumpSelection(‘tables’) Use print statements or domoticz.log() statements in your script at cricital locations to see if the Lua interpreter reaches that line. Don’t try to print a device object though; use the <code>myDevice.dump()</code> method for that. It wil log all attributes of the device in the Domoticz log.

If you place a print statement all the way at the top of your script file it will be printed every time dzVents loads your script (that is done at the beginning of each event cycle). Sometimes that is handy to see if your script gets loaded in the first place. If you don’t see your print statement in the log, then likely dzVents didn’t load it and it will not work.


=== Get help ===

The Domoticz forum is a great resource for help and solutions. Check the [https://www.domoticz.com/forum/viewforum.php?f=59 dzVents forum].


= Other interesting stuff =


== lodash for Lua ==

lodash is a well known and very popular Javascript library filled with dozens of handy helper functions that really make you life a lot easier. Fortunately there is also a Lua version. This is directly available through the domoticz object:

<syntaxhighlight lang="lua">local _ = domoticz.utils._
_.print(_.indexOf({2, 3, 'x', 4}, 'x'))</syntaxhighlight>

Check out the documentation [https://htmlpreview.github.io/?https://github.com/rwaaren/lodash.lua/blob/master/doc/index.html here].


= History [https://wiki.domoticz.com/DzVents_version_History link to changes in previous versions]. =

See link for the complete list of changes

https://wiki.domoticz.com/DzVents_version_History

DzVents: next generation Lua scripting

2026-08-02T17:07:02Z

Walter vl: /* Thermostat 6 3.1.11 */

'''Note''': This document is maintained on [https://github.com/domoticz/domoticz/blob/development/dzVents/documentation/README.md github], and the wiki version is automatically generated. Edits should be performed on github, or they may be suggested on the wiki article’s [https://wiki.domoticz.com/Talk:DzVents:_next_generation_Lua_scripting Discussion page]. Editing can be done by any editor but if you are looking for a specialized markDown editor; [https://stackedit.io/app# stackedit.io] would be a good choice.


= About dzVents =

dzVents /diː ziː vɛnts/, short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts. And … '''it is 100% Lua'''! So if you already have a bunch of event scripts for Domoticz, upgrading should be fairly easy.

Let’s start with an example. Say you have a switch that when activated, it should activate another switch but only if the room temperature is above a certain level. And when done, it should send a notification. This is how it looks in dzVents:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'Room switch'}
},

execute = function(domoticz, roomSwitch)
if (roomSwitch.active and domoticz.devices('Living room').temperature > 18) then
domoticz.devices('Another switch').switchOn()
domoticz.notify('This rocks!',
'Turns out that it is getting warm here',
domoticz.PRIORITY_LOW)
end

}</syntaxhighlight>
Or you have a timer script that should be executed every 10 minutes, but only on weekdays, and have it do something with some user variables and only during daytime:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
--activate my scene
domoticz.scenes('Evening lights').switchOn()
if (domoticz.devices('My PIR').lastUpdate.minutesAgo > 5) then
domoticz.devices('Bathroom lights').switchOff()
end
end
end
}</syntaxhighlight>
Or you want to detect a humidity rise within the past 5 minutes:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'every 5 minutes'}
},
data =
{
previousHumidity = { initial = 100 }
},
execute = function(domoticz)
local bathroomSensor = domoticz.devices('BathroomSensor')
if (bathroomSensor.humidity - domoticz.data.previousHumidity) >= 5 then
-- there was a significant rise
domoticz.devices('Ventilator').switchOn()
end
-- store current value for next cycle
domoticz.data.previousHumidity = bathroomSensor.humidity
end
}</syntaxhighlight>
Just to give you an idea! Everything in your Domoticz system is now logically available in the domoticz object structure. With this domoticz object, you can get to all the information in your system and manipulate your devices.


= Using dzVents with Domoticz =

In Domoticz go to '''Setup > Settings > Other''' and in the section EventSystem make sure the check-box ‘dzVents disabled’ is not checked. Also make sure that in the Security section in the settings '''(Setup > Settings > System > Local Networks (no username/password)''' you allow 127.0.0.1 (and / or ::1 when using IPv6 ) to not need a password. dzVents does use this port to get the location settings and to send certain commands to Domoticz. Finally make sure you have set your current location in '''Setup > Settings > System > Location''', otherwise there is no way to determine nighttime/daytime state.

There are two ways of creating dzVents event scripts in Domoticz:

# By creating scripts in your domoticz instance on your domoticz server: <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Make sure that each script has the extension <code>.lua</code> and follows the guidelines as described below.
# By creating scripts inside Domoticz using the internal Domoticz event editor: Go to '''Setup > More Options > Events'''. Press the + button and choose dzVents. You must then choose a template. They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

'''Note: scripts that you write on the file-system and inside Domoticz using the internal web-editor all share the same name-space. That means that if you have two scripts with the same name, only the one of the file-system will be used. The log will tell you when this happens.'''

'''Note: Scripts created in the internal editor are stored in the domoticz database and are all written to <code>/path/to/domoticz/scripts/dzVents/generated_scripts</code> on every domoticz restart and every “EventSystem: reset all events…”. Scripts in <code>/path/to/domoticz/scripts/dzVents/scripts</code> are not stored in the database and should be backed-up separately. '''


== Quickstart ==

If you made sure that dzVents system is active, we can do a quick test if everything works:

* Pick a switch in your Domoticz system. Write down the exact name of the switch. If you don’t have a switch then you can create a Dummy switch and use that one.
* Create a new file in the <code>/path/to/domoticz/scripts/dzVents/scripts/</code> folder (or using the web-editor in Domoticz, switch to dzVents mode first.). Call the file <code>test.lua</code>. ''Note: when you create a script in the web-editor you do '''not''' add the .lua extension!'' Also, valid script names follow the same rules as [https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words filesystem names].
* Open <code>test.lua</code> in an editor and fill it with this code and change <code><exact name of the switch></code> with the .. you guessed it… exact name of the switch device:

<syntaxhighlight lang="lua"> return {
on = {
devices = {
'<exact name of the switch>'
}
},
execute = function(domoticz, switch)
if (switch.state == 'On') then
domoticz.log('Hey! I am on!')
else
domoticz.log('Hey! I am off!')
end
end
}</syntaxhighlight>
* Save the script
* Open the Domoticz log in the browser
* In Domoticz GUI perhaps in another browser tab) press the switch.
* You can watch the log in Domoticz and it should show you that indeed it triggered your script and you should see the log messages.

See the examples folder <code>/path/to/domoticz/scripts/dzVents/examples</code> for more examples. This folder includes templates you can use to get started as well. And, if you use the GUI web editor to write your script, you will find boilerplate examples in the drop-down below the script type setting.


= Writing scripts =

In order for your scripts to work with dzVents, they have to be turned into a Lua module with a specific structure. Basically you make sure it returns a Lua table (object) with predefined keys like <code>on</code> and <code>execute</code>. Here is an example:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'My switch' }
},

execute = function(domoticz, switch)
-- your script logic goes here, something like this:
if (switch.state == 'On') then
domoticz.log('I am on!', domoticz.LOG_INFO)
end
end
}</syntaxhighlight>
Simply said, the <code>on</code>-part defines the trigger and the <code>execute</code> part is what should be done if the trigger matches with the current Domoticz event. So all your logic is inside the <code>execute</code> function.


== Sections in the script ==

Each dzVents event script has this structure:

<syntaxhighlight lang="lua">return
{
active = true, -- optional
on =
{
-- at least one of these:
customEvents = { ... },
devices = { ... },
groups = { ... },
httpResponses = { ... },
scenes = { ... },
security = { ... },
shellCommandResponses = { ... },
system = { ... },
timer = { ... },
variables = { ... },

},
data = { ... }, -- optional
logging = { ... }, -- optional
execute = function(domoticz, item, triggerInfo)
-- your code here
end
}</syntaxhighlight>

=== active = true/false (optional) ===

If <code>active = false</code>, then the script is not activated: ''dzVents will ignore the script completely''. If you don’t have <code>active</code> specified, <code>true</code> is assumed (default value). If you write scripts with Domoticz’ internal script editor then you don’t need this part as the editor has its own way of enabling and disabling scripts.

So, <code>active</code> can either be:

* '''true''': (default) the script file will be processed.
* '''false''': the script file is ignored.
* '''function(domoticz) … end''': A function returning <code>true</code> or <code>false</code>. The function will receive the domoticz object with all the information about your domoticz instance: <code>active = function(domoticz) .... end</code>. For example you could check for a Domoticz variable or switch and prevent the script from being executed. '''However, be aware that for ''every script'' in your scripts folder, this active function will be called, every cycle!! Therefore, it is better to put all your logic in the execute function instead of in the active function.'''


=== on = { … } ===

The <code>on</code> section tells dzVents ''when'' the execute function has to be executed. It holds all the events/'''triggers''' that are monitored by dzVents. If any of the events or triggers match with the current event coming from Domoticz, then the <code>execute</code> part of the script is executed by dzVents. The <code>on</code> section has many kinds of subsections that ''can all be used simultaneously'' :


==== customEvents = { … } 3.0.0 ====

A list of one or more custom event triggers. This eventTrigger can be activate by a json/api call, a MQTT message (when domoticz is setup to listen to such messages on the hardware tab) or by the dzVents internal command domoticz.emitEvent - The name of the custom-event - The name of the custom-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|See time trigger rules]].


===== API =====

<pre>- curl: curl -d "{ 'a':10, 'b':20, 'some':'text', 'sub' : { 'x':10, 'y':20 } }" "http://<domoticzIP:domoticz port>/json.htm?type=command&param=customevent&event=<myCustomEvent>"
- JSON: **< domoticzIP : domoticz port >**/json.htm?type=command&param=customevent&event=<MyEvent>&data=myData
- MQTT simple: {"command":"customevent", "event":"MyEvent","data":"myData"}
- MQTT complex: {"command":"customevent","event":"MyEvent","data":"{\"idx\":29,\"test\":\"ok\"}" }
- emitEvent: domoticz.emitEvent('myCustomEvent' [,])
`domoticz.emitEvent('myEvent') -- no data`
`domoticz.emitEvent('another event', 'some data')`
`domoticz.emitEvent('hugeEvent', { a = 10, b = 20, some = 'text', sub = { x = 10, y = 20 } })`</pre>

===== Attributes =====

The customEvent object (second parameter in your execute function) has these attributes:

* '''data''': Raw customEvent data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''.3.0.3 true when the customEvent data is a valid json string. The data is then automatically converted to a Lua table.
* '''isXML''': ''Boolean''. 3.0.3 true when the customEvent data is a valid xml string. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. 3.0.3 When the customEvent data is a valid json string, the response data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a table for quick and easy access. nil otherwise
* '''trigger''', '''customEvent''': ''String''.3.0.3 The string that triggered this customEvent instance. This is useful if you have a script that can be triggered by multiple different customEvent strings.
* '''xml'''. ''Table''. 3.0.3 When the response data is a valid xml string, the customEvent data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


==== devices = { … } ====

A list of device-names or indexes. If a device in your system was updated (e.g. a switch was triggered or a new temperature was received) and it is listed in this section then the execute function is executed. '''Note''': update does not necessarily means the device state or value has changed. Each device can be:

* The name of your device between string quotes. '''You can use the asterisk (*) wild-card here e.g. <code>PIR_*</code> or <code>*_PIR</code>'''. E.g.: <code>devices = { 'myDevice', 'anotherDevice', 123, 'pir*' }</code>
* The index (idx) of your device (as the name may change, the index will usually stay the same, the index can be found in the devices section in Domoticz). '''Note that idx is a number;'''
* The name or idx of your device followed by a time constraint, such as: <code>['myDevice'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if <code>myDevice</code> was changed, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].


==== groups = { …} ====

A list of one or more group-names or indexes. The same rules as devices apply.


==== httpResponses = { …} ====

A list of one or more http callback triggers. Use this in conjunction with <code>domoticz.openURL()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


==== shellCommandResponses = { …} 3.1.0 ====

A list of one or more scriptcommand callback triggers. Use this in conjunction with <code>domoticz.executeShellCommand()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.


==== scenes = { … } ====

A list of one or more scene-names or indexes. The same rules as devices apply. So if your scene is listed in this table then the executed function will be triggered, e.g.: <code>on = { scenes = { 'myScene', 'anotherScene' } },</code>.


==== security = { … } ====

A list of one or more of these security states:

* <code>domoticz.SECURITY_ARMEDAWAY</code>,
* <code>domoticz.SECURITY_ARMEDHOME</code>,
* <code>domoticz.SECURITY_DISARMED</code>

If the security state in Domoticz changes and it matches with any of the states listed here, the script will be executed. See <code>/path/to/domoticz/scripts/dzVents/examples/templates/security.lua</code> for an example see [[#Security_Panel|Security Panel]] for information about how to create a security panel device.


==== system = { …} 3.0.0 ====

A list of one or more system triggers.

* <code>stop</code>, <code>start</code>, <code>manualBackupFinished</code>, <code>dailyBackupFinished</code>, <code>hourlyBackupFinished</code>, <code>monthlyBackupFinished</code>, <code>resetAllDeviceStatus</code>, 3.1.5 <code>resetAllEvents</code>, 3.1.5
* The name of the system-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].
** '''start''' - fired when Domoticz has started.
** '''stop''' - fired when Domoticz is shutting down. As you probably can imagine you have only a limited amount of time - also depending on the load on your system - to have Domoticz do stuff when your script has been completed. Some commands will probably not be executed. Just give it a try.
** '''Backups''' - the trigger item (2nd parameter of the execute function) is a table that holds information about the newly created backup (location, duration in seconds and type). You could use this information to copy the file to some other location or for another purpose.
*** '''dailyBackupFinished''' - automatic backup when set in domoticz
*** '''hourlyBackupFinished''' - ” ”
*** '''monthlyBackupFinished''' - ” ”
*** '''manualBackupFinished''' - fired when you start a backup using the Domoticz GUI or via '''< domoticz IP:domoticz port >'''/backupdatabase.php
*** '''resetAllDeviceStatus''' 3.1.5- fired when the name, description or used / unused state of a device, variable or scene is updated.
*** '''resetAllEvents''' 3.1.5- fired when a dzVents script in the internal editor changed.


==== timer = { … } ====

A list of one ore more time ‘rules’ like <code>every minute</code> or <code>at 17:*</code>. See [[#timer_trigger_rules|''timer'' trigger rules]]. If any or the rules matches with the current time/date then your execute function is called. E.g.: <code>on = { timer = { 'between 30 minutes before sunset and 30 minutes after sunrise' } }</code>.


==== variables = { … } ====

A list of one or more user variable-names as defined in Domoticz ( ''Setup > More options > User variables''). If any of the variables listed here is updated, ( '''Note''': update does not necessarily means the variable value or type changed ).the script is executed. '''Note''': Script will only execute when this variable is updated directly by dzVents or by a JSON. If updated with a standard Lua script (using commandArray) or in combination with a time option like afterAAA no event will be triggered.


=== execute = function('''domoticz, item, triggerInfo''') … end ===

When all the above conditions are met (active == true and the on section has at least one matching rule), then this <code>execute</code> function is called. This is the heart of your script. The function has three parameters:


==== 1. ('''domoticz''', item, triggerInfo) ====

The [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]]. This object gives you access to almost everything in your Domoticz system, including all methods to manipulate them—like modifying switches or sending notifications. More about the [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]] below.


==== 2. (domoticz, '''item''', triggerInfo) ====

Depending on what actually triggered the script, <code>item</code> is either a:

* [[#Custom_event_API|customEvent]] 3.0.0
* [[#Device_object_API|device]],
* [[#Variable_object_API_.28user_variables.29|variable]],
* [[#Scene|scene]],
* [[#Group|group]],
* [[#timer_=_%7B_..._%7D|timer]],
* [[#System_event_API|system]], 3.0.0
* [[#Security_Panel|security]] or
* [[#Asynchronous_HTTP_requests|httpResponse]]
* [[#Asynchronous_shell_command_executio|shellCommandResponse]] 3.1.0

Since you can define multiple on-triggers in your script, it is not always clear what the type is of this second parameter. In your code you need to know this in order to properly respond to the different events. To help you inspect the object you can use these attributes like <code>if (item.isDevice) then ... end</code>:

* '''isCustomEvent''': 3.0.0. returns <code>true</code> if the item is a customEvent object.
* '''isDevice''': . returns <code>true</code> if the item is a Device object.
* '''isGroup''': . returns <code>true</code> if the item is a Group object.
* '''isHTTPResponse''': . returns <code>true</code> if the item is an HTTPResponse object.
* '''isShellCommandResponse''': . 3.1.0 returns <code>true</code> if the item is a shellcommandResponse object.
* '''isScene''': . returns <code>true</code> if the item is a Scene object.
* '''isSecurity''': . returns <code>true</code> if the item is a Security object.
* '''isSystemEvent''': 3.0.0. returns <code>true</code> if the item is a system object.
* '''isTimer''': . returns <code>true</code> if the item is a Timer object.
* '''isVariable''': . returns <code>true</code> if the item is a Variable object.
* '''trigger''': . ''string''. the timer rule, the security state, the customEvent or the http response callback string that actually triggered your script. E.g. if you have multiple timer rules can inspect <code>trigger</code> which exact timer rule was fired.


==== 3. (domoticz, item, '''triggerInfo''') ====

'''Note''': as of version 2.4.0, <code>triggerInfo</code> has become more or less obsolete and is left in here for backward compatibility. All information is now available on the <code>item</code> parameter (second parameter of the execute function, see point 2 above).

<code>triggerInfo</code> holds information about what triggered the script. The object has two attributes:

# '''type''': the type of the the event that triggered the execute function, either: - domoticz.EVENT_TYPE_CUSTOM,3.0.0 - domoticz.EVENT_TYPE_DEVICE, - domoticz.EVENT_TYPE_GROUP - domoticz.EVENT_TYPE_HTTPRESPONSE - domoticz.EVENT_TYPE_SCENE, - domoticz.EVENT_TYPE_SECURITY, - domoticz.EVENT_TYPE_SYSTEM,3.0.0 - domoticz.EVENT_TYPE_TIMER, - domoticz.EVENT_TYPE_VARIABLE)
# '''trigger''': the timer rule that triggered the script if the script was called due to a timer event, or the security state that triggered the security trigger rule. See [[#timer_trigger_rules|below]] for the possible timer trigger rules.
# '''scriptName''': the name of the current script.


==== Tip: rename the parameters to better fit your needs ====

The names of the execute parameters are actually something you can change to your convenience. For instance, if you only have one trigger for a specific switch device, you can rename <code>item</code> it to <code>switch</code>. Or if you think <code>domoticz</code> is too long you can rename it to <code>d</code> or <code>dz</code> (might save you a lot of typing and may make your code more readable):

<syntaxhighlight lang="lua">return
{
on =
{
devices = 'mySwitch'
},
execute = function(dz, mySwitch)
dz.log(mySwitch.state, dz.LOG_INFO)
end
}</syntaxhighlight>

=== data = { … } (optional) ===

The optional data section allows you to define local variables that will hold their values ''between'' script runs. These variables can get a value in your execute function and the next time the script is executed these variables will have their previous state restored. For more information see the section [[#Persistent_data|Persistent data]].


=== logging = { … } (optional) ===

The optional logging section allows you to override the global logging setting of dzVents as set in ''Setup > Settings > Other > EventSystem > dzVents Log Level''. This can be handy when you only want this script to have extensive debug logging while the rest of your script executes silently. You have these options:

* '''level''': This is the minimum log level you want for this script. This can be domoticz.LOG_INFO, domoticz.LOG_STATUS, domoticz.LOG_ERROR or domoticz.LOG_DEBUG
* '''marker''': A string that is prefixed before each log message. That way you can easily create a filter in the Domoticz log to see just these messages. '''marker''' defaults to scriptname

\*LOG_DEBUG will also cause Execution Info to be displayed (start/finished)

Example:

<syntaxhighlight lang="lua">logging = {
level = domoticz.LOG_DEBUG,
marker = "Hey you"
},</syntaxhighlight>

== Some trigger examples ==


=== Custom events ===

Suppose you want to trigger a script not on the minute but 30 seconds later.

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every minute',
},

customEvents =
{
'delayed',
},
},
execute = function(domoticz, item)
if item.isTimer then
domoticz.emitEvent('delayed', domoticz.time.rawTime ).afterSec(30)
else
domoticz.notify('Delayed', 'Event was emitted at ' .. item.data, domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Device changes ===

Suppose you have two devices—a smoke detector ‘myDetector’ and a room temperature sensor ‘roomTemp’, and you want to send a notification when either the detector detects smoke or the temperature is too high:

<syntaxhighlight lang="lua">return
{
on =
{
devices = {
'myDetector',
'roomTemp'
}
},
execute = function(domoticz, device)
if ((device.name == 'myDetector' and device.active) or
(device.name == 'roomTemp' and device.temperature >= 45)) then
domoticz.notify('Fire', 'The room is on fire', domoticz.PRIORITY_EMERGENCY)
end
end
}</syntaxhighlight>

=== Scene / group changes ===

Suppose you have a scene ‘myScene’ and a group ‘myGroup’, and you want to turn on the group as soon as myScene is activated:

<syntaxhighlight lang="lua">return {
on = {
scenes = { 'myScene' }
},
execute = function(domoticz, scene)
if (scene.state == 'On') then
domoticz.groups('myGroup').switchOn()
end
end
}</syntaxhighlight>
Or, if you want to send an email when a group is activated at night:

<syntaxhighlight lang="lua">return {
on = {
groups = { ['myGroup'] = {'at nighttime'} }
},
execute = function(domoticz, group)
if (group.state == 'On') then
domoticz.email('Hey', 'The group is on', 'someone@the.world.org')
end
end
}</syntaxhighlight>

=== Timer events ===

Suppose you want to check the soil humidity every 30 minutes during the day and every hour during the night:

<syntaxhighlight lang="lua">return {
on = {
timer = {
'every 30 minutes at daytime',
'every 60 minutes at nighttime'
}
},
execute = function(domoticz, timer)
domoticz.log('The rule that triggered the event was: ' .. timer.trigger')
if (domoticz.devices('soil').moisture > 100) then
domoticz.devices('irrigation').switchOn().forMin(60)
end
end
}</syntaxhighlight>

=== Variable changes ===

Suppose you have a script that updates a variable ‘myAmountOfMoney’, and if that variable reaches a certain level you want to be notified:

<syntaxhighlight lang="lua">return
{
on =
{
variables = { 'myAmountOfMoney' }
},
execute = function(domoticz, variable)
-- variable is the variable that's triggered
if (variable.value > 1000000) then
domoticz.notify('Rich', 'You can stop working now', domoticz.PRIORITY_HIGH)
end
end
}</syntaxhighlight>

=== Security changes ===

Suppose you have a group holding all the lights in your house, and you want to switch it off as soon as the alarm is activated:

<syntaxhighlight lang="lua">return
{
on =
{
security = { domoticz.SECURITY_ARMEDAWAY }
},
execute = function(domoticz, security)
domoticz.groups('All lights').switchOff()
end
}</syntaxhighlight>

=== Asynchronous HTTP Request and handling ===

Suppose you have some external web service that will tell you what the current energy consumption is and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
httpResponses = { 'energyRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = 'http://url/to/service',
method = 'GET',
callback = 'energyRetrieved'
})
elseif (item.isHTTPResponse) then
if (item.ok) then -- statusCode == 2xx
local current = item.json.consumption
domoticz.devices('myCurrentUsage').updateEnergy(current)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


=== Asynchronous shell command execution 3.1.0 ===

Suppose you have some local shellcommand to measure the speed of your internet connection and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
shellCommandResponses = { 'internetspeedRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.executeShellCommand({
command = 'speedtest-cli --json', -- just an example
callback = 'internetspeedRetrieved', -- see shellCommandResponses above.
timeout = 20, -- max execution time in seconds
})
elseif (item.isShellCommandResponse) then
if (item.statusCode==0) then
domoticz.devices('myCurrentdownloadspeed').updateCustomSensor(item.json.download)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_shell_command_execution|asynchronous shell commands]] for more information.


=== System changes ===

Do some initial work when domoticz starts

<syntaxhighlight lang="lua">return
{
on =
{
system =
{
'start',
'backupDoneDaily',
},

},

execute = function(domoticz, system)
domoticz.log('Domoticz sends ' .. system.type, domoticz.LOG_INFO)

if system.type == 'start' then
domoticz.device('initial device').switchOff().silent
domoticz.variables('special startVar').set('domoticz started at ' .. domoticz.time.rawDateTime )
elseif system.type == 'backupDoneDaily' then
domoticz.notify('Domoticz backup', 'Ended. Backupfile ' .. system.data.location , domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Combined rules ===

Let’s say you have a script that checks the status of a lamp and is triggered by motion detector:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
devices = { 'myDetector' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- the timer was triggered
domoticz.devices('myLamp').switchOff()
elseif (item.isDevice and item.active) then
-- it must be the detector
domoticz.devices('myLamp').switchOn()
end
end
}</syntaxhighlight>

=== At startup trigger ===

You can add <code>at_startup = true</code> to the <code>on</code> section to have your script execute once when Domoticz starts, in addition to any other triggers. This is useful when combined with interval-based rules to avoid waiting for the first interval to pass:

<syntaxhighlight lang="lua">return {
on = {
at_startup = true,
timer = { 'every hour' },
},
execute = function(domoticz, item)
-- Runs immediately when Domoticz starts, then every hour
domoticz.devices('myThermostat').setPoint(21)
end
}</syntaxhighlight>
The <code>at_startup</code> trigger fires on the first timer tick after Domoticz starts (within 2 minutes of startup). It can be combined with any other trigger types (timer, devices, httpResponses, etc.).

'''Note:''' This is different from <code>system = { 'start' }</code> which is a system event trigger. <code>at_startup</code> is simpler - just add the flag and your existing script will also run at startup without needing to check <code>item.isSystemEvent</code>.


== ''timer'' trigger rules ==

There are several options for time triggers. It is important to know that Domoticz timer events only trigger once every minute, so one minute is the smallest interval for your timer scripts. However, dzVents gives you many options to have full control over when and how often your timer scripts are called (all times are in 24hr format and all dates in dd/mm): Keywords recognized are “at, between, every, except, in, on, or” ( except supported from version 3.0.16, or supported from version 3.1.8 ).

At every place you read <astroMoment> you can use one of: sunset, sunrise, solarnoon, midnight '', sunatsouth '', civiltwilightstart, civiltwilightend, astronomicaltwilightstart '', astronomicaltwilightend '', nauticaltwilightstart * or nauticaltwilightend *.

Full daynames are allowed in dzVents >= 3.1.7

* 3.1.16

<syntaxhighlight lang="lua"> on = {
timer = {
'every minute', -- causes the script to be called every minute
'every other minute', -- minutes: xx:00, xx:02, xx:04, ..., xx:58
'every <xx> minutes', -- starting from xx:00 triggers every xx minutes
-- (0 > xx < 60)
'every hour', -- 00:00, 01:00, ..., 23:00 (24x per 24hrs)
'every other hour', -- 00:00, 02:00, ..., 22:00 (12x per 24hrs)
'every <xx> hours', -- starting from 00:00, triggers every xx
-- hours (0 > xx < 24)
'at 13:45', -- specific time
'at *:45', -- every 45th minute in the hour
'at 15:*', -- every minute between 15:00 and 16:00
'at 12:45-21:15', -- between 12:45 and 21:15. You cannot use '*'!
'at 19:30-08:20', -- between 19:30 and 8:20 (next day)
'at 13:45 on mon,tue', -- at 13:45 only on Mondays and Tuesdays (english)
'on mon,tue', -- on Mondays and Tuesdays
'every hour on Saturday', -- you guessed it correctly
'at sunset', -- uses sunset/sunrise/solarnoon info from Domoticz
'at sunrise',
'at <astroMoment>', -- dzVents >= 3.0.16 Uses the times received from Domoticz
'at <astroMoment> on sat,sun',
'xx minutes before <astroMoment>', --
'xx minutes after <astroMoment>', -- Please note that these relative times will cross dates
'between aa and bb' -- aa/bb can be a time stamp like 15:44 (if aa > bb will cross dates)
-- aa/bb can be sunrise/sunset/solarnoon ('between sunset and sunrise' and 'between solarnoon and sunrise' will cross dates)
-- aa/bb can be 'xx minutes before/after <astroMoment>'
'at <astroRange>', -- between <astroMoment>start and <astroMoment>end
'at nighttime', -- between sunset and sunrise
'at daytime', -- between sunrise and sunset
'at daytime on mon,tue', -- between sunrise and sunset only on Mondays and Tuesdays
'in week 1-7,44' -- in week 1-7 or 44
'in week 20-25,33-47' -- between week 20 and 25 or week 33 and 47
'in week -12, 33-' -- week <= 12 or week >= 33
'every odd week',
'every even week', -- odd or even numbered weeks
'on 23/11', -- on 23rd of November (dd/mm)
'on 23/11-25/12', -- between 23/11 and 25/12
'on 2/3-8/3,7/8,6/10-14/10',-- between march 2 and 8, on august 7 and between October 6 and 14.
'on */2,15/*', -- every day in February or
-- every 15th day of the month
'on -3/4,4/7-', -- before 3/4 or after 4/7

'at 12:45-21:15 except at 18:00-18:30', -- between 12:45 and 21:15 but not between 18:00 and 18:30 ( except supported from 3.0.16 onwards )
'at daytime except on sun', -- between sunrise and sunset but not on Sundays
'at daytime or at 23:12', -- between sunrise and sunset and also at 23:12

-- or if you want to go really wild and combine them:
'at nighttime at 21:32-05:44 every 5 minutes on sat, sun except at 04:00', -- except supported from 3.0.16 onwards
'every 10 minutes between 20 minutes before sunset and 30 minutes after sunrise on mon,fri,tue on 20/5-18/8'

-- or just do it yourself:
function(domoticz)
-- you can use domoticz.time to get the current time
-- note that this function is called every minute!
-- custom code that either returns true or false
...
end
},
}</syntaxhighlight>
The timer events are triggered every minute. If such a trigger occurs, dzVents will scan all timer-based events and will evaluate the timer rules. So, if you have a rule <code>on mon</code> then the script will be executed ''every minute'' but only on Monday.

Be mindful of the logic if using multiple types of timer triggers. It may not make sense to combine a trigger for a specific or instantaneous time with a trigger for a span or sequence of times (like ‘at sunset’ with ‘every 6 minutes’) in the same construct. Similarly, <code>'between aa and bb'</code> only makes sense with instantaneous times for <code>aa</code> and <code>bb</code>.

'''One important note: if Domoticz, for whatever reason, skips a timer event then you may miss the trigger! Therefore, you should build in some fail-safe checks or some redundancy if you have critical time-based stuff to control. There is nothing dzVents can do about it'''

'''Tip:''' If you want your timer script to also run at Domoticz startup (instead of waiting for the first timer match), add <code>at_startup = true</code> to your <code>on</code> section. See [[#at-startup-trigger|At startup trigger]].

Another important issue: the way it is implemented right now, the <code>every xx minutes</code> and <code>every xx hours</code> is a bit limited. The interval resets at every *:00 (for minutes) or 00:* for hours. You need an interval that is an integer divider of 60 (or 24 for the hours). So you can do every 1, 2, 3, 4, 5, 6, 10, 12, 15, 20 and 30 minutes only.


= The domoticz object =

The domoticz object passed as the first parameter to the <code>execute</code> function contains everything you need to interact with your domotica system. It provides all information made available by the domoticz event system about your custom- and system events, devices, scenes, groups, hardware modules and variables and has methods needed to inspect and manipulate them. Getting this information is easy:

<code>domoticz.time.isDayTime</code> or <code>domoticz.devices('My sensor').temperature</code> or <code>domoticz.devices('My sensor').lastUpdate.minutesAgo</code>.

The domoticz object consists of a logically arranges structure. It harbors all methods to manipulate Domoticz. dzVents will take care to notify Domoticz with all your intended changes and actions. Earlier you had to fill a commandArray with obscure commands. That’s no longer the case.

Some more examples: <code>domoticz.devices(123).switchOn().forMin(5).afterSec(10)</code> or <code>domoticz.devices('My dummy sensor').updateBarometer(1034, domoticz.BARO_THUNDERSTORM)</code>.

One tip before you get started: '''Make sure that all your devices have unique names. dzVents will give you warnings in the logs if device names are not unique.'''


== Domoticz object API (Application Programming Interface) ==

The domoticz object holds all information about your Domoticz system. It has global attributes and methods to query and manipulate your system. It also has a collection of '''devices''', '''variables''' (user variables in Domoticz), '''scenes''', '''groups''', '''hardware'''. Each of these collections has four iterator functions: <code>find(), forEach()</code>, <code>filter()</code> and <code>reduce()</code> to make searching for devices easier. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]].


=== Domoticz attributes and methods ===

* '''devices(idx/name)''': ''Function''. A function returning a device by idx or name: <code>domoticz.devices(123)</code> or <code>domoticz.devices('My switch')</code>. For the device API see [[#Device_object_API|Device object API]]. To iterate over all devices do: <code>domoticz.devices().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.devices()) do .. end</code>.
* '''dump([osfile]3.0.0)''': ''Function''. Dump all domoticz.settings attributes to the Domoticz log. This ignores the log level setting.
* '''email(subject, message, mailTo [, delay]3.0.10)''': ''Function''. Send email. Optional parm delay is delay in seconds.
* '''emitEvent(name,[extra data ])''':''Function''. 3.0.0 Have Domoticz ‘call’ a customEvent. If you just pass a name then Domoticz will execute the script(s) that subscribed to the named customEvent after your script has finished. You can optionally pass extra information as a string or table. A table will be automatically converted into a json string and converted back to a table in the subscribed script(s). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''executeShellCommand(command/options)''': ''Function''. 3.1.0 Have Domoticz ‘call’ a command. If you just pass a command then Domoticz will execute the command after your script has finished but you will not get notified. If you pass options table with a callback then you have the possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_shell_command_execution|asynchronous shell commands]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. '''Note Make sure that when you use this function on a Windows system and use one or more of the special chars &<>()@^| outside double quotes, you will have to escape these with a ^ char '''
* '''groups(idx/name)''': ''Function'': A function returning a group by name or idx. Each group has the same interface as a device. To iterate over all groups do: <code>domoticz.groups().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.groups()) do .. end</code>. Read more about [[#Group|Groups]].
* '''hardwareInfo(idx/name)''': 3.0.6 ''Function'': A function returning hardwareInfo of a hardware module by name or idx. The return of the function is a table with attributes name, type, typeValue, deviceNames (table with names of all active devices defined on this hardware) and deviceIds (table with idx of all active devices defined on this hardware)
* '''hardware(idx/name)''': 3.0.7 ''Function'': A function returning a hardware module by name or idx. Each hardware has an interface comparable to group. To iterate over all hardware do: <code>domoticz.hardware().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.hardware()) do .. end</code>. Read more about [[#Hardware|Hardware]].
* '''helpers''': ''Table''. Collection of shared helper functions available to all your dzVents scripts. See [[#Shared_helper_functions|Shared helper functions]].
* '''log(message, [level])''': ''Function''. Creates a log entry in the Domoticz log but respects the log minimum level settings. You can provide the loglevel: <code>domoticz.LOG_INFO</code>, <code>domoticz.LOG_STATUS</code>, <code>domoticz.LOG_ERROR</code>, <code>domoticz.LOG_DEBUG</code> or <code>domoticz.LOG_FORCE</code>. In Domoticz settings you can set the default log level for dzVents.
* '''moduleLabel''': 3.0.3 Module (script) name without extension.
* '''notify(subject, message [,priority][,sound][,extra][,subsystem][,delay]3.0.10 )''': ''Function''. Send a notification (like Prowl). Priority can be like <code>domoticz.PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY</code>. <code>extra</code> is notification subsystem specific. For NSS_FIREBASE you can use this field to specify the target mobile (‘midx_1’, midx_2, etc..) or specify <code>device.id</code> so the receiver knows which device triggered the notification. For sound see [[#Constants|list of dzVents Constants]] for the SOUND constants below. <code>subsystem</code> defaults to all subsystems but can be one subsystem or a table containing one or more notification subsystems. See [[#Constants|list of dzVents Constants]] for <code>domoticz.NSS_subsystem</code> types. Delay is delay in seconds
* '''openURL(url/options)''': ''Function''. Have Domoticz ‘call’ a URL. If you just pass a url then Domoticz will execute the url after your script has finished but you will not get notified. If you pass a table with options then you have to possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_HTTP_requests|asynchronous http requests]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''scenes(idx/name)''': ''Function'': A function returning a scene by name or id. Each scene has the same interface as a device. See [[#Device_object_API|Device object API]]. To iterate over all scenes do: <code>domoticz.scenes().forEach(..)</code>. See [[#looping-through-the-collections-iterators|Looping through the collections: iterators]]. (#Looping_through_the_collections:_iterators). Note that you cannot do <code>for i, j in pairs(domoticz.scenes()) do .. end</code>. Read more about [[#Scene|Scenes]].
* '''security''': Holds the state of the security system e.g. <code>Armed Home</code> or <code>Armed Away</code>.
* '''sendCommand(command, value[, delay] 3.0.10)''': Generic (low-level)command method (adds it to the commandArray) to the list of commands that are being sent back to domoticz. Optional parm delay is delay in seconds ''There is likely no need to use this directly. Use any of the device methods instead (see below).''
* '''settings''':
** '''domoticzVersion''': domoticz version string.
** '''dzVentsVersion''': dzVents version string.
** '''location'''
*** '''latitude''': domoticz settings locations latitude.
*** '''longitude''': domoticz settings locations longitude.
*** '''name''': domoticz settings location Name.
** '''secureServer''': ''boolean'' 3.1.1 true when domoticz can be accessed via https.
** '''serverPort''': webserver listening port used by dzVents to access domoticz API.
** '''url''': internal url to access the API service.
** '''webRoot''': <code>webroot</code> 3.1.1 value as specified when starting the Domoticz service (or default).
** '''wwwBind''': <code>wwwbind</code> 3.1.4 value as specified when starting the Domoticz service (or default).
* '''sms(message [, delay] 3.0.10 )''': ''Function''. Sends an sms if it is configured in Domoticz. Optional parm delay is delay in seconds.
* '''snapshot(cameraID(s) or camera Name(s)3.0.13,subject)''': ''Function''. Sends email with a camera snapshots if email is configured and set for attachments in Domoticz. Send 1 or multiple camerIDs -names in ; separated string or array.

<syntaxhighlight lang="lua"> dz.snapshot() -- defaults to id = 1, subject domoticz
dz.snapshot(1,'dz') -- subject dz
dz.snapshot('1;2;3') -- ; separated string
dz.snapshot({1,4,7}) -- table
dz.snapshot('test;test2') -- ; separated string
dz.snapshot({'test', 'test2'}) -- table</syntaxhighlight>
<ul>
<li>'''switchTimerPlan(idx)''': ''Function''. Switch the active timer plan to the plan with the given database ID. <code>idx</code> must be a positive integer matching an existing timer plan ID (as shown in '''Settings → Timer Plans'''). Invalid or non-existent plan IDs are silently ignored. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''startTime''': ''[[#Time_object|Time Object]]''. Returns the startup time of the Domoticz service.</li>
<li>'''systemUptime''': ''Number''. Number of seconds the system is up.</li>
<li>'''time''': ''[[#Time_object|Time Object]]'': Current system time. Additional to Time object attributes:
<ul>
<li>'''isDayTime''': ''Boolean''</li>
<li>'''isNightTime''': ''Boolean''</li>
<li>'''isCivilDayTime''': ''Boolean''.</li>
<li>'''isCivilNightTime''': ''Boolean''.</li>
<li>'''isToday''': ''Boolean''. Indicates if the device was updated today</li>
<li>'''sunriseInMinutes''': ''Number''. Number of minutes since midnight when the sun will rise.</li>
<li>'''sunsetInMinutes''': ''Number''. Number of minutes since midnight when the sun will set.</li>
<li>'''civTwilightStartInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will start.</li>
<li>'''civTwilightEndInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will end.</li></ul></li>
<li>'''triggerHTTPResponse([httpResponse], [delay], [message])''': ''Function''. Creates a callback by sending a logmessage. httpResponse defaults to scriptname, delay defaults to 0 (immediate), message defaults to httpResponse. Left in for backward compatibility only. You can use emitEvent / customEvents now.</li>
<li>'''triggerIFTTT(makerName [,sValue1, sValue2, sValue3])''': ''Function''. Have Domoticz ‘call’ an IFTTT maker event. makerName is required, 0-3 sValue’s are optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''utils''': . A subset of handy utilities: Note that these functions must be preceded by domoticz.utils. If you use more then a few declare something like local _u = domoticz.utils at the beginning of your script and use _u.functionName in the remainder. Example:
<syntaxhighlight lang="lua"> _u = domoticz.utils
print(_u.rightPad('test',10) .. '|||') -- => test |||</syntaxhighlight>
<ul>
<li>'''_.lodashFunctions''': This is an entire collection with very handy Luafunctions. Read more about [[#lodash_for_Lua|lodash]]. E.g.: <code>{.lua} domoticz.utils._.size({'abc', 'def'}))` Returns 2.</code></li>
<li>'''cameraExists(parm)''': ''Function'': returns name when entered with a valid camera 3.0.12 or cameraID and return ID when entered with valid cameraName or false when not a camera, cameraID or cameraName of an existing camera</li>
<li>'''deviceExists(parm)''': ''Function'': returns name when entered with a valid device 3.0.12 or deviceID and returns ID when entered with valid deviceName or false when not a device, deviceID or deviceName of an existing (and active) device. Example:
<syntaxhighlight lang="lua">local dz = domoticz
local _u = dz.utils
if _u.deviceExists('myDevice') then
dz.devices('myDevice').switchOn()
else
dz.log('Device myDevice does not exist!', dz.LOG_ERROR)
end

local myName = _u.deviceExists(123)
if myName then
dz.log('Device 123 is ' .. myName, dz.LOG_INFO)
else
dz.log('Device 123 does not exist', dz.LOG_ERROR)
end</syntaxhighlight></li>
<li>'''dumpTable(table,[levelIndicator],[osfile]3.0.0))''': ''Function'': print table structure and contents to log</li>
<li>'''fileExists(path)''': ''Function'': Returns <code>true</code> if the file (with full path) exists.</li>
<li>'''fromBase64(string)''': ''Function'': Decode a base64 string</li>
<li>'''fromJSON(json, fallback, deSerialize 3.1.8 )''': ''Function''. Turns a json string to a Lua table. Example: <code>local t = domoticz.utils.fromJSON('{ "a": 1 }')</code>. Followed by: <code>print( t.a )</code> will print 1. Optional 2nd param fallback will be returned if json is nil or invalid. Optional 3rd param deSerialize (boolean) determines if the JSON should be deserialized before converting.</li>
<li>'''fromXML(xml, fallback )''': ''Function'': Turns a xml string to a Lua table. Example: <code>local t = domoticz.utils.fromXML('<testtag>What a nice feature!</testtag>') Followed by:</code>print( t.texttag)` will print What a nice feature! Optional 2nd param fallback will be returned if xml is nil or invalid.</li>
<li>'''fuzzyLookup([string|array of strings], parm)''': ''Function'': 3.0.14. Search fuzzy matching string in parm. If parm is string it returns a number (lower is better match). If parm is array of strings it returns the best matching string.</li>
<li>'''groupExists(parm)''': ''Function'': returns name when entered with a valid group 3.0.12 or groupID and return ID when entered with valid groupName or false when not a group, groupID or groupName of an existing group</li>
<li>'''hardwareExists(parm)''': ''Function'': 3.0.7 returns name when entered with valid hardwareID or ID when entered with valid hardwareName or false when not a hardwareID or hardwareName of an existing (and active )hardware module</li>
<li>'''inTable(table, searchString)''': ''Function'': Returns <code>"key"</code> if table has searchString as a key, <code>"value"</code> if table has searchString as value and <code>false</code> otherwise.</li>
<li>'''isJSON(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘application/json’ or string is enclosed in {} and <code>false</code> otherwise.</li>
<li>'''isXML(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘text/xml’ or ‘application/xml’ or string is enclosed in <> and <code>false</code> otherwise.</li>
<li>'''leftPad(string, length [, character])''': ''Function'': Precede string with given character(s) (default = space) to given length.</li>
<li>'''centerPad(string, length [, character])''': ''Function'': Center string by preceding and succeeding with given character(s) (default = space) to given length.</li>
<li>'''numDecimals(number [, integer [, decimals ]])''': ''Function'': Format number to float representation. ''Examples:''</li></ul>

<syntaxhighlight lang="lua"> domoticz.utils.numDecimals(12.23, 4, 4) -- => 12.2300,
domoticz.utils.numDecimals (12.23,1,1) -- => 12.2,
domoticz.utils.leadingZeros(domoticz.utils.numDecimals (12.23,4,4),9) -- => 0012.2300</syntaxhighlight>
<ul>
<li>'''osCommand(cmd)''': ''Function'': 3.0.13 Execute an OS command and return result and returncode. Note: For long running scripts <code>domoticz.executeShellCommand()</code> should be used, See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''osExecute(cmd)''': ''Function'': Execute an OS command (no return). Note: For long running scripts <code>executeShellCommand()</code> should be used. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''rightPad(string, length [, character])''': ''Function'': Succeed string with given character(s) (default = space) to given length.</li>
<li>'''round(number, [decimalPlaces])''': ''Function''. Helper function to round numbers. Default decimalPlaces is 0.</li>
<li>'''sceneExists(parm)''': ''Function'': returns name when entered with valid scene 3.0.12 or sceneID and return ID when entered with valid sceneName or false when not a scene, sceneID or sceneName of an existing scene</li>
<li>'''setLogMarker([marker])''': ''Function'': set logMarker to ‘marker’. Defaults to scriptname. Can be used to change logMarker based on flow in script</li>
<li>'''splitLine(string , splitOnWord ) 3.1.8)''':''Function''. Helper function to split a line. Return is a table with line-segments.</li>
<li>'''stringSplit(string [,separator ] [,convertNumber ][,convertNil ]3.0.17)''':''Function''. Helper function to split a line in separate words. Default separator is space. Return is a table with separated words. Default convertNumber is false when set to true it will convert strings to number where possible. Word is ignored when nil, unless convertNil is set; in that case word will be set to the convertNil value.</li>
<li>'''stringToSeconds(str)''': ''Function'': 3.0.1 Returns number of seconds between now and str. ''Examples:''
<syntaxhighlight lang="lua">domoticz.utils.stringToSeconds('09:00') -- number of seconds between now and 09:00 hr.
domoticz.utils.stringToSeconds('08:53:30 on fri') -- number of seconds between now and Friday at 08:53:30
domoticz.utils.stringToSeconds('08:53:30 on sat, sun') -- number of seconds between now and Saturday or Sunday at 08:53:30 ;whatever comes first</syntaxhighlight></li>
<li>'''toBase64(string)''': ''Function'': ) Encode a string to base64</li>
<li>'''toCelsius(f, relative)''': ''Function''. Converts temperature from Fahrenheit to Celsius along the temperature scale or when relative == true it uses the fact that 1F = 0.56C. So <code>toCelsius(5, true)</code> returns 5F*(1/1.8) = 2.78C.</li>
<li>'''toJSON(luaTable)''': ''Function''. Converts a Lua table to a json string.</li>
<li>'''toXML(luaTable, [header])''': ''Function''. Converts a Lua table to a xml string.</li>
<li>'''urlDecode(s)''': ''Function''. Simple deCoder to convert a string with escaped chars (%20, %3A and the likes) to human readable format.</li>
<li>'''urlEncode(s, [strSub])''': ''Function''. Simple url encoder for string so you can use them in <code>openURL()</code>. <code>strSub</code> is optional and defaults to + but you can also pass %20 if you like/need.</li>
<li>'''variableExists(parm)''': ''Function'': returns name when entered with a valid variable 3.0.12 or variableID and return ID when entered with valid variableName or false when not a variable, variableID or variableName of an existing variable</li>
<li>'''leadingZeros(number, length)''': ''Function'': Precede number with given zeros to given length.</li>
<li>'''variables(idx/name)''': ''Function''. A function returning a variable by it’s name or idx. See [Variable object API] (#Variable_object_API_.28user_variables.29) for the attributes. To iterate over all variables do: <code>domoticz.variables().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. '''Note that you cannot do <code>for i, j in pairs(domoticz.variables()) do .. end</code>'''.</li></ul></li></ul>


=== Looping through the collections: iterators ===

The domoticz object has these collections (tables): devices, scenes, groups, variables, changedDevices and changedVariables. You cannot use the <code>pairs()</code> or <code>ipairs()</code> functions. Therefore dzVents has four iterator methods:

# '''find(function)''': Returns the item in the collection for which <code>function</code> returns true. When no item is found <code>find</code> returns nil.
# '''forEach(function)''': Executes function once per array element. The function receives the item in the collection (device or variable). If the function returns ''false'', the loop is aborted.
# '''filter(function / table)''': returns items in the collection for which the function returns true. You can also provide a table with names and/or ids.
# '''reduce(function, initial)''': Loop over all items in the collection and do some calculation with it. You call it with the function and the initial value. Each iteration the function is called with the accumulator and the item in the collection. The function does something with the accumulator and returns a new value for it.


==== Examples: ====

find():

<syntaxhighlight lang="lua"> local myDevice = domoticz.devices().find(function(device)
return device.name == 'myDevice'
end)
domoticz.log('Id: ' .. myDevice.id)</syntaxhighlight>
forEach():

<syntaxhighlight lang="lua"> domoticz.devices().forEach(function(device)
if (device.batteryLevel < 20) then
-- do something
end
end)</syntaxhighlight>
filter():

<syntaxhighlight lang="lua"> local deadDevices = domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end)
deadDevices.forEach(function(zombie)
-- do something
end)</syntaxhighlight>
or

<syntaxhighlight lang="lua"> local livingLights = {
'window',
'couch',
33, -- kitchen light id
}
local lights = domoticz.devices().filter(livingLights)
lights.forEach(function(light)
-- do something
light.switchOn()
end)</syntaxhighlight>
Of course you can chain:

<syntaxhighlight lang="lua"> domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end).forEach(function(zombie)
-- do something with the zombie
end)</syntaxhighlight>
Using a reducer to count all devices that are switched on:

<syntaxhighlight lang="lua"> local count = domoticz.devices().reduce(function(acc, device)
if (device.state == 'On') then
acc = acc + 1 -- increase the accumulator
end
return acc -- always return the accumulator
end, 0) -- 0 is the initial value for the accumulator</syntaxhighlight>

=== Constants ===

The domoticz object has these constants available for use in your code e.g. <code>domoticz.LOG_INFO</code>.

'''IMPORTANT: you have to prefix these constants with the name of your domoticz object. Example: <code>domoticz.ALERTLEVEL_RED</code>''':

* '''ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_ORANGE, ALERTLEVEL_RED, ALERTLEVEL_YELLOW''': for updating text sensors.
* '''BASETYPE_CUSTOM_EVENT 3.0.0,BASETYPE_DEVICE, BASETYPE_SCENE, BASETYPE_GROUP, BASETYPE_HARDWARE''' 3.0.7, '''BASETYPE_VARIABLE, BASETYPE_SECURITY, BASETYPE_TIMER, BASETYPE_HTTP_RESPONSE, BASETYPE_SYSTEM'''3.0.0: indicators for the various object types that are passed as the second parameter to the execute function. E.g. you can check if an object is a device object: <code>Lua if (item.baseType == domoticz.BASETYPE_DEVICE) then ... end</code>
* '''BARO_CLOUDY, BARO_CLOUDY_RAIN, BARO_STABLE, BARO_SUNNY, BARO_THUNDERSTORM, BARO_NOINFO, BARO_UNSTABLE, BARO_COMPUTE''' : for updating barometric values.
* '''EVENT_TYPE_DEVICE, EVENT_TYPE_VARIABLE, EVENT_TYPE_CUSTOM''', 3.0.0 '''EVENT_TYPE_SECURITY, EVENT_TYPE_HTTPRESPONSE, EVENT_TYPE_SYSTEM,''' 3.0.0 '''EVENT_TYPE_TIMER''': triggerInfo types passed to the execute function in your scripts.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_TEMPORARY_OVERRIDE, EVOHOME_MODE_PERMANENT_OVERRIDE, EVOHOME_MODE_FOLLOW_SCHEDULE''': mode for EvoHome system.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_AUTOWITHRESET, EVOHOME_MODE_AUTOWITHECO, EVOHOME_MODE_AWAY, EVOHOME_MODE_DAYOFF, EVOHOME_MODE_CUSTOM, EVOHOME_MODE_HEATINGOFF''' : mode for EvoHome controller
* '''HUM_COMFORTABLE, HUM_DRY, HUM_NORMAL, HUM_WET, HUM_COMPUTE''' 3.0.15: constant for humidity status.
* '''INTEGER, FLOAT, STRING, DATE, TIME''': variable types.
* \**LOG_INFO, LOG_STATUS, LOG_ERROR, LOG_DEBUG, LOG_FORCE: for logging messages. LOG_FORCE will always be displayed.
* '''NSS_CLICKATELL''' 3.1.3, '''NSS_FIREBASE, NSS_FIREBASE_CLOUD_MESSAGING, NSS_GOOGLE_DEVICES,''' 3.0.10 Only with installed casting plugin, '''NSS_HTTP, NSS_KODI, NSS_LOGITECH_MEDIASERVER, NSS_NMA,NSS_PROWL, NSS_PUSHALOT, NSS_PUSHBULLET, NSS_PUSHOVER, NSS_PUSHSAFER, NSS_TELEGRAM, NSS_GOOGLE_CLOUD_MESSAGING''' deprecated by Google and replaced by firebase: for notification subsystem
* '''PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY''': for notification priority.
* '''SECURITY_ARMEDAWAY, SECURITY_ARMEDHOME, SECURITY_DISARMED''': for security state.
* '''STATE_IDLE, STATE_COOLING, STATE_HEATING''': for thermostat operating state.
* '''SOUND_ALIEN , SOUND_BIKE, SOUND_BUGLE, SOUND_CASH_REGISTER, SOUND_CLASSICAL, SOUND_CLIMB , SOUND_COSMIC, SOUND_DEFAULT, SOUND_ECHO, SOUND_FALLING, SOUND_GAMELAN, SOUND_INCOMING, SOUND_INTERMISSION, SOUND_MAGIC, SOUND_MECHANICAL, SOUND_NONE, SOUND_PERSISTENT, SOUND_PIANOBAR , SOUND_SIREN, SOUND_SPACEALARM, SOUND_TUGBOAT, SOUND_UPDOWN''': for notification sounds.


== Custom event API ==

If you have a dzVents script that is triggered by a customEvent in Domoticz then the second parameter passed to the execute function will be a ''notification'' object. The object.type = customEvent (isCustomEvent: true) and object.data contains the passed data to this script. object.trigger is the name of the customEvent that triggered the script.


== Device object API ==

If you have a dzVents script that is triggered by switching a device in Domoticz then the second parameter passed to the execute function will be a ''device'' object. Also, each device in Domoticz can be found in the <code>domoticz.devices()</code> collection (see above). The device object has a set of fixed attributes like ''name'' and ''idx''. Many devices, however, have different attributes and methods depending on their (hardware)type, subtype and other device specific identifiers. It is possible that you will get an error if you call a method on a device that doesn’t support it, so please check the device properties for your specific hardware to see which are supported (can also be done in your script code!).

dzVents recognizes most of the different device types in Domoticz and creates the proper attributes and methods. It is possible that your device type has attributes that are not recognized; if that’s the case, please create a ticket in the Domoticz [https://github.com/domoticz/domoticz/issues issue tracker on GitHub], and an adapter for that device will be added.

If for some reason you miss a specific attribute or data for a device, then likely the <code>rawData</code> attribute will have that information.


== Device attributes and methods for all devices ==

<ul>
<li>'''active''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Same as bState.</li>
<li>'''baseType''' ''String''. ‘camera’, ‘device’, ‘group’, ‘scene’, ‘hardware’, ‘uservariable’ or ‘security’</li>
<li>'''batteryLevel''': ''Number'' If applicable for that device then it will be from 0-100.</li>
<li>'''bState''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Better to use active.</li>
<li>'''changed''': ''Boolean''. True if the device was updated. '''Note''': This does not necessarily means the device state or value changed.</li>
<li>'''customImage''': ''Number''. When customImage is used for the device-icon this will be the icon-number. It will be 0 if the icon was not changed.</li>
<li>'''description''': ''String''. Description of the device.</li>
<li>'''deviceId''': ''String''. Another identifier of devices in Domoticz. dzVents uses the id(x) attribute. See device list in Domoticz’ settings table.</li>
<li>'''deviceSubType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''deviceType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''dump()''': ''Function''. Dump all attributes except functions and complete time overview to the Domoticz log. This ignores the log level setting. Use fullDump to include everything.</li>
<li>'''dumpSelection([{‘attributes’} ‘functions’ ‘tables’])''': ''Function''. 3.0.5 Dump attributes, function-names or table-names to the Domoticz log. This ignores the log level setting.</li>
<li>'''fullDump()''' ''Function''. 3.1.16 Dump all attributes including functions and the complete time overview to the Domoticz log. This ignores the log level setting. Most of the time dump() shows everything what is needed to debug.</li>
<li>'''hardwareName''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareId''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''icon''': ''String''. Name of the icon in Domoticz GUI.</li>
<li>'''id''': ''Number''. Index of the device. You can find the index in the device list (idx column) in Domoticz settings. It’s not truly an index but is unique enough for dzVents to be treated as an id.</li>
<li>'''idx''': ''Number''. Same as id: index of the device</li>
<li>'''inActive''': ''Boolean''. 3.1.0 true if active is false and vice versa. If active is nil inActive is also nil</li>
<li>'''lastUpdate''': ''[[#Time_object|Time Object]]'': Time when the device was updated. **Note: The lastUpdate for devices that triggered the script at hand is in fact the previousUpdate time. The real lastUpdate time for these “script triggering” devices is the current time.</li>
<li>'''name''': ''String''. Name of the device.</li>
<li>'''nValue''': ''Number''. Numerical representation of the state.</li>
<li>'''protected''': ''Boolean''. True when device / scene / group is protected. False otherwise.</li>
<li>'''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]</li>
<li>'''protectionOn()''': ''Function''. switch protection to on. Supports some [command options] !! **Note: domoticz protects against GUI and API access only. switchOn / switchOff type Blockly / Lua / dzVents commands are not influenced (because they are executed as admin user)</li>
<li>'''rawData''': ''Table'': All values are ''String'' types and hold the raw data received from Domoticz.</li>
<li>'''rename(newName)''': ''Function''. Change current devicename to new devicename Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setDescription(description)''': ''Function''. Generic method to update the description for all devices, groups and scenes. E.g.: device.setDescription(device.description .. ‘/nChanged by’.. item.trigger .. ‘at’ .. domoticz.time.raw). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setIcon(iconNumber)''': ''Function''. method to update the icon for devices. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setState(newState)''': ''Function''. Generic update method for switch-like devices. E.g.: device.setState(‘On’). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''resumeTimerPlan()''': ''Function''. Finds the most recent timer that should have fired today (before now) for this device, scene, or group and executes it immediately. Useful for restoring the correct state after a Domoticz restart or power cut. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. ```lua – Replay last timer for a device domoticz.devices(‘My Light’).resumeTimerPlan()
– Replay last timer for a scene domoticz.scenes(‘Evening Scene’).resumeTimerPlan()
– Replay last timer for a group domoticz.groups(‘All Lights’).resumeTimerPlan() ```</li>
<li>'''setValues(nValue,[ sValue1, sValue2, …])''': ''Function''. Generic alternative method to update device nValue, sValues. Uses domoticz JSON API to force subsequent pushes like influxdb and MQTT. nValue required but when set to nil it defaults to current nValue. sValue parms are optional and can be many. 3.0.8 If one of sValue parms is ‘parsetrigger’, subsequent eventscripts will be triggered.</li>
<li>'''state''': ''String''. For switches, holds the state like ‘On’ or ‘Off’. For dimmers that are on, it is also ‘On’ but there is a level attribute holding the dimming level. '''For selector switches''' (Dummy switch) the state holds the ''name'' of the currently selected level. The corresponding numeric level of this state can be found in the '''rawData''' attribute: <code>device.rawData[1]</code>.</li>
<li>'''signalLevel''': ''Number'' If applicable for that device then it will be from 0-12</li>
<li>'''switchType''': ''String''. See Domoticz devices table in Domoticz GUI(Switches tab). E.g. ‘On/Off’, ‘Door Contact’, ‘Motion Sensor’ or ‘Blinds’</li>
<li>'''sValue''': ''String''. Returns the sValue (string Value) of a device.</li>
<li>'''switchTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''timedOut''': ''Boolean''. Is true when the device couldn’t be reached.</li>
<li>'''unit''': ''Number''. Device unit. See device list in Domoticz’ settings for the unit.</li>
<li>'''update(< params >)''': ''Function''. Generic update method. Accepts any number of parameters that will be sent back to Domoticz. There is no need to pass the device.id here. It will be passed for you. Example to update a temperature: <code>device.update(0,12)</code>. This will eventually result in a commandArray entry <code>['UpdateDevice']='<idx>|0|12'</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''updateQuiet(nValue, sValue)''': ''Function''. 3.0.18 Uses the JSON/API to send nValue and/or sValue to domoticz (at least one should be supplied). Will update the device status in the GUI and trigger events but will not execute the action on the device. Only useful when the status in the GUI is not in line with the actual status. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li></ul>


=== Device attributes and methods for specific devices ===

Note that if you do not find your specific device type here you can always inspect what is in the <code>rawData</code> attribute. Please let us know that it is missing so we can write an adapter for it (or you can write your own and submit it). Calling <code>myDevice.dump()</code> will dump all attributes and values for myDevice to the Domoticz log.


==== Air quality ====

* '''co2''': ''Number''. PPM
* '''quality''': ''String''. Air quality string.
* '''updateAirQuality(ppm)''': Pass the CO2 concentration. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Alert sensor ====

* '''color''': ''Number''. Color of the alert. See domoticz color constants for possible values.
* '''text''': ''String''
* '''updateAlertSensor(level, text)''': ''Function''. Level can be domoticz.ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_YELLOW, ALERTLEVEL_ORANGE, ALERTLEVEL_RED. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 1-phase ====

* '''current''': ''Number''. Ampère.
* '''updateCurrent(current)''': ''Function''. Current in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 3-phase ====

* '''current1''', '''current2''', '''current3''' : ''Number''. Ampère.
* '''updateCurrent(current1, current2, current3)''': ''Function''. Currents in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Barometer sensor ====

* '''barometer'''. ''Number''. Barometric pressure.
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''updateBarometer(pressure, forecast)''': ''Function''. Update barometric pressure. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Counter, managed Counter, counter incremental ====

* '''counter''': ''Number''
* '''counterToday''': ''Number''. Today’s counter value.
* '''updateCounter(value)''': ''Function''. '''Overwrite current value for managed and standard counters; increment for incremental counters !!'''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateHistory( date, sValues )''': ''Strings'' 3.1.3 ''function'' Managed counter only! Used to write values to short or long term storage.

<syntaxhighlight lang="lua"> local mCounter = domoticz.devices('device name')
mCounter.updateHistory('2021-01-22', '10;1777193') -- Write to long term storage (meter_calendar table)
mCounter.updateHistory('2021-01-22 10:05:02', '10;1777193') -- Write to short term storage (meter table)</syntaxhighlight>
* '''incrementCounter(value)''': ''Function''. (counter incremental) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. To update with a complete new value you will have to do some calculation and take the counter divider into account.

<syntaxhighlight lang="lua"> local newValue = value
local iCounter = domoticz.devices('device name')
local counterDivider = x -- x is depending on the counter divider set for the device
iCounter.incrementCounter( ( -1 * iCounter.counter * counterDivider ) + newValue )</syntaxhighlight>
* '''valueQuantity''': ''String''. For counters.
* '''valueUnits''': ''String''.


==== Custom sensor ====

* '''sensorType''': ''Number''.
* '''sensorUnit''': ''String'':
* '''sensorValue''': 3.0.11 ''Number'' where applicable; else ''String'':
* '''updateCustomSensor(value)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Distance sensor ====

* '''distance''': ''Number''.
* '''updateDistance(distance)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Electric usage ====

* '''actualWatt''': ''Number''. Current Watt usage.
* '''WhActual''': ''Number''. Current Watt usage. (please use actualWatt)
* '''updateEnergy(energy)''': ''Function''. In Watt. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Evohome (controller) ====

* '''mode''': ''string'' 3.0.0.
* '''setMode(mode, dparm, action, ooc )''': ''Function''. set mode for controller. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_AUTOWITHRESET, domoticz.EVOHOME_MODE_AUTOWITHECO, domoticz.EVOHOME_MODE_AWAY, domoticz.EVOHOME_MODE_DAYOFF, domoticz.EVOHOME_MODE_CUSTOM or domoticz.EVOHOME_MODE_HEATINGOFF. dParm <optional> can be a future time string (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>), a future time object, a future time as number of seconds since epoch or a number representing a positive offset in minutes (max 1 year). action <optional> (1 = run on action script, 0 = disable), ooc <optional> (1 = only trigger the event & log on change, 0 = always trigger & log)


==== Evohome (hotWater) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''mode''': ''string''
* '''untilDate''': ''string in ISO 8601 format'' or n/a.
* '''setHotWater(state, mode, until)''': ''Function''. set HotWater Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE You can provide an until date (in ISO 8601 format for domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>).


==== Evohome (relay) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''level''': ''number'' (level percentage)
* '''active''': ''boolean'' (true when state is not equal to ‘Off’, false otherwise)


==== Evohome (zones) ====

* '''setPoint''': ''Number''.
* '''mode''': ''string'' .
* '''untilDate''': ''string in ISO 8601 format'' or n/a .
* '''updateSetPoint(setPoint, mode, until)''': ''Function''. Update set point. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE. You can provide an until date (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>). When leaving out untilDate for mode domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE the untilDate will be the next scheduled zone-update time/date. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Gas ====

* '''counter''': ''Number''. Value in m3
* '''counterToday''': ''Number''. Value in m3
* '''updateGas(usage)''': ''Function''. Usage in '''dm3''' (liters). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Group ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current group-name to new group-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleGroup()''': Toggles the state of a group. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Hardware 3.0.7 ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''isHardware''': ''Boolean''
* '''isPythonPlugin''': ''Boolean''
* '''type''': : ''String''
* '''typeValue''': : ''Number''


==== Humidity sensor ====

* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''updateHumidity(humidity, status)''': Update humidity. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Kodi ====

* '''kodiExecuteAddOn(addonId)''': ''Function''. Will send an Execute Addon command sending no parameters. Addon IDs are embedded in the addon configuration and are not to be confused with the Addon Name. For example: http://forums.homeseer.com/showthread.php?p=1213403.
* '''kodiPause()''': ''Function''. Will send a Pause command, only effective if the device is streaming.
* '''kodiPlay()''': ''Function''. Will send a Play command, only effective if the device was streaming and has been paused.
* '''kodiPlayFavorites([position])''': ''Function''. Will play an item from the Kodi’s Favorites list optionally starting at ''position''. Favorite positions start from 0 which is the default.
* '''kodiPlayPlaylist(name, [position])''': ''Function''. Will play a music or video Smart Playlist with ''name'' optionally starting at ''position''. Playlist positions start from 0 which is the default.
* '''kodiSetVolume(level)''': ''Function''. Set the volume for a Kodi device, 0 <= level <= 100.
* '''kodiStop()''': ''Function''. Will send a Stop command, only effective if the device is streaming.
* '''kodiSwitchOff()''': ''Function''. Will turn the device off if this is supported in settings on the device.


==== kWh, Electricity (instant and counter) ====

* '''actualWatt''': ''Number''. Actual usage in Watt.
* '''counterToday''': ''Number''.
* '''updateElectricity(power, energy)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''WhToday''': ''Number''. Total Wh usage of the day. Note the unit is Wh and not kWh!
* '''WhTotal''': ''Number''. Total Wh usage.
* '''WhActual''': ''Number''. Actual reading in Watt. Please use actualWatt


==== Leaf wetness ====

* '''wetness''': ''Number''. Wetness value
* '''updateWetness(wetness)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Logitech Media Server ====

* '''pause()''': ''Function''. Will pause the device if it was streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''play()''': ''Function''. If the device was off, it will turn on and start streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playFavorites([position])''': ''Function''. Will start the favorites playlist. <code>position</code> is optional (0 = default). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playlistID''': ''Nubmer''.
* '''setVolume(level)''': ''Function''. Sets the volume (0 <= level <= 100). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''startPlaylist(name)''': ''Function''. Will start the playlist by its <code>name</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Will stop the device (only effective if the device is streaming). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeUp()''': ''Function''. Will turn the device volume up with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeDown()''': ''Function''. Will turn the device volume down with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Lux sensor ====

* '''lux''': ''Number''. Lux level for light sensors.
* '''updateLux(lux)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Onkyo receiver ====

* '''onkyoEISCPCommand(command)'''. ''Function''. Sends an EISP command to the Onkyo receiver.


==== OpenTherm gateway ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== P1 Smart meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterToday''': ''Number''.
* '''usage1''', '''usage2''': ''Number''.
* '''return1''', '''return2''': ''Number''.
* '''updateP1(usage1, usage2, return1, return2, cons, prod)''': ''Function''. Updates the device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''usageDelivered''': ''Number''.


==== Percentage ====

* '''percentage''': ''Number''.
* '''updatePercentage(percentage)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Philips Hue Light ====

See switch below.


==== Pressure ====

* '''pressure''': ''Number''.
* '''updatePressure(pressure)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Rain meter ====

* '''rain''': ''Number'' (please note that this does return the rain total for today)
* '''rainRate''': ''Number''
* '''updateRain(rate, counter)''': ''Function''. (rate in mm * 100 per hour, counter is total in mm) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== RGBW(W) / Lighting Limitless/Applamp ====

* '''decreaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''getColor()'''; ''Function''. Returns table with color attributes or nil when color field of device is not set.
* '''increaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''setColor(r, g, b, br, cw, ww, m, t)''': ''Function''. Sets the light to requested color. r, g, b required, others optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. Meaning and limits of parms can be found [https://wiki.domoticz.com/Domoticz_API/JSON_URL's#Set_a_light_to_a_certain_color_or_color_temperature here].
* '''setColorBrightness()''': same as setColor
* '''setDiscoMode(modeNum)''': deprecated because only very limited supported and will be removed from API
* '''setHex(r, g, b)''': ''Function''. Sets the light to requested color. r, g, b required (decimal Values 0-255). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setHue(hue, brightness, isWhite)''': ''Function''. Sets the light to requested Hue. Hue and brightness required. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setKelvin(Kelvin)''': ''Function''. Sets Kelvin level of the light (For RGBWW devices only). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setNightMode()''': ''Function''. Sets the lamp to night mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setRGB(red, green, blue)''': ''Function''. Set the lamps RGB color. Values are from 0-255. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setWhiteMode()''': ''Function''. Sets the lamp to white mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scale weight ====

* '''weight''': ''Number''
* '''udateWeight()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scene ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current scene-name to new scene-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Security Panel ====

Create a security device:

# Set a security panel password in Domoticz settings.
# Activate the security panel ('''Setup > More Options > Security Panel''' and set it to '''Disarm''' (using your password)).
# Go to the device list in ('''Setup > Devices''') where it should show the security panel device under ‘Not used’.
# Add the device and give it a name.

Methods/attributes:

* '''armAway()''': Sets a security device to Armed Away. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''armHome()''': Sets a security device to Armed Home. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''disarm()''': Disarms a security device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''state''': ''String'': Same values as domoticz.security value.


==== Smoke detection ====

* '''activate()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''reset()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Solar radiation ====

* '''radiation'''. ''Number''. In Watt/m2.
* '''updateRadiation(radiation)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Soil moisture ====

* '''moisture'''. ''Number''. In centibars (cB).
* '''updateSoilMoisture(moisture)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Sound level ====

* '''level'''. ''Number''. In dB.
* '''updateSoundLevel(level)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Switch (dimmer, selector etc.) ====

There are many switch-like devices. Not all methods are applicable for all switch-like devices. You can always use the generic <code>setState(newState)</code> method.

* '''close()''': ''Function''. Set device to Close if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''dimTo(percentage)''': ''Function''. Switch a dimming device on and/or dim to the specified level. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''lastLevel''': Number. The level of a dimmer just before it was switched off. '''Note: lastLevel only shows you the previous level if you have a trigger for the device itself. So for instance you have a on-trigger for ‘myDimmer’ and the dimmer is set from 20% to 30%, in your script <code>myDimmer.level == 30</code> and <code>myDimmer.lastLevel == 20</code>. '''
* '''level''': ''Number''. For dimmers and other ‘Set Level..%’ devices this holds the level like selector switches.
* '''levelActions''': ''String''. |-separated list of url actions for selector switches.
* '''levelName''': ''String''. Current level name for selector switches.
* '''levelNames''': ''Table''. Table holding the level names for selector switch devices.
* '''levelVal''': ''Number''. Specific for selector switches.
* '''maxDimLevel''': ''Number''.
* '''open()''': ''Function''. Set device to Open if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOn()''': ''Function''. Set deviceStatus to on without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOff()''': ''Function''. set deviceStatus to off without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setLevel(percentage)''': ''Function''. Set device to a given level if it supports it (e.g. blinds percentage). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Set device to Stop if it supports it (e.g. blinds). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Switch device off it is supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Switch device on if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchSelector(<[level]|[levelname] >)''' : ''Function''. Switches a selector switch to a specific level ( levelname or level(numeric) required ) levelname must be exact, for level the closest fit will be picked. See the edit page in Domoticz for such a switch to get a list of the values). Levelname is only supported when level 0 (“Off”) is not removed Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleSwitch()''': ''Function''. Toggles the state of the switch (if it is togglable) like On/Off, Open/Close etc.


==== Temperature sensor ====

* '''temperature''': ''Number''
* '''updateTemperature(temperature)''': ''Function''. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Barometer sensor ====

* '''barometer''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''temperature''': ''Number''
* '''updateTempBaro(temperature, pressure, forecast)''': ''Function''. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity, Barometer sensor ====

* '''barometer''': ''Number''
* '''dewPoint''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHumBaro(temperature, humidity, status, pressure, forecast)''': ''Function''. forecast can be domoticz.BARO_NOINFO, BARO_SUNNY, BARO_PARTLY_CLOUDY, BARO_CLOUDY, BARO_RAIN. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET, HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity ====

* '''dewPoint''': ''Number''
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHum(temperature, humidity [, status] )''': ''Function''. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET or HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Text ====

* '''text''': ''String''
* '''updateText(text)''': Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat set point ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat Operating state 3.0.19 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat type 3 (Mertik) 3.0.15 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat 6 3.1.11 ====

Thermostat 6 devices come in several subtypes: Temp/Setpoint, Temp/Hum/Setpoint, Temp/Baro/Setpoint and Temp/Hum/Baro/Setpoint.

* '''setPoint''': ''Number''. The current set point.
* '''humidityStatusValue''': ''Number''. Mapped humidity status value (only for subtypes with humidity).
* '''updateSetPoint(setPoint)''': ''Function''. Update the set point. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)''': ''Function''. Update thermostat values. Parameters depend on the subtype:
** ''Temp/Setpoint'': <code>updateThermostat(temperature, setPoint)</code>
** ''Temp/Hum/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus)</code>
** ''Temp/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, nil, nil, barometer, forecast)</code>
** ''Temp/Hum/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)</code>
*** <code>forecast</code> can be a string: <code>'noinfo'</code>, <code>'sunny'</code>, <code>'partlycloudy'</code>, <code>'cloudy'</code>, <code>'rain'</code> or a numeric value.
*** <code>humidityStatus</code> can be a string: <code>'dry'</code>, <code>'normal'</code>, <code>'comfortable'</code>, <code>'wet'</code> or a numeric value. If omitted with humidity provided, it is auto-calculated.



==== UV sensor ====

* '''uv''': ''Number''. UV index.
* '''updateUV(uv)''': ''Function''. UV index. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Visibility ====

* '''visibility''': ''Number''. In km.
* '''updateVisibility(distance)''':Function*. In km. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Voltage ====

* '''voltage''': ''Number''.
* '''updateVoltage(voltage)''':Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Waterflow ====

* '''flow''': ''Number''. In L/m.
* '''updateWaterflow(flow)''':Function*. In L/m. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Wind ====

* '''chill''': ''Number''.
* '''direction''': ''Number''. Degrees.
* '''directionString''': ''String''. Formatted wind direction like N, SE.
* '''gust''': ''Number''. ( in meters / second, might change in future releases to Meters/Counters settings for Wind Meter )
* '''gustMs''': ''Number''. Gust ( in meters / second )
* '''temperature''': ''Number''
* '''speed''': ''Number''. Windspeed ( in the unit set in Meters/Counters settings for Wind Meter )
* '''speedMs''': ''Number''. Windspeed ( in meters / second )
* '''updateWind(bearing, direction, speed, gust, temperature, chill)''': ''Function''. Bearing in degrees, direction in N, S, NNW etc, speed in m/s, gust in m/s, temperature and chill in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Youless meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterDeliveredTotal''': ''Number''.
* '''powerYield''': ''String''.
* '''updateYouless(total, actual)''': ''Function''.


==== Zone heating ====

* '''setPoint''': ''Number''.
* '''heatingMode''': ''String''.


==== Z-Wave Fan mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Z-Wave Thermostat mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== Command options (delay, duration, event triggering) ===

Many dzVents device methods support extra options, like controlling a delay or a duration:

<syntaxhighlight lang="lua">
-- switch on for 2 minutes after 10 seconds
device.switchOn().afterSec(10).forMin(2)

-- switch on at a specic time / day
device.switchOn().at('09:00') -- earliest moment it will be 09:00 hr.
device.switchOn().at('08:53:30 on fri') -- earliest moment it will be Friday at 08:53:30
device.switchOn().at('08:53:30 on sat, sun') -- earliest moment it will be Saturday or Sunday at 08:53:30 (whatever comes first)

-- switch on for 2 minutes after a randomized delay of 1-10 minutes
device.switchOff().withinMin(10).forMin(2)
device.close().forMin(15)
device.open().afterSec(20)
device.open().afterMin(2)

-- switch on but do not trigger follow up events
device.switchOn().silent()

-- flash a light for 3 times
device.switchOn().forSec(2).repeatAfterSec(1, 3)

-- switch the device on but only if the current state isn't already on:
device.switchOn().checkFirst()
-- this is a short for:
if (device.state == 'Off') then
devices.switchOn()
end</syntaxhighlight>

==== Options ====

* '''at(hh:mm[:ss][ on [ ddd|dddd ] )''': ''Function''.3.0.1 Activates the command at a certain time [ on a certain day]
* '''afterHour(hours), afterMin(minutes), afterSec(seconds)''': ''Function''. Activates the command after a certain number of hours, minutes or seconds.
* '''cancelQueuedCommands()''': ''Function''. Cancels queued commands. E.g. you switch on a device after 10 minutes: <code>myDevice.switchOn().afterMin(10)</code>. Within those 10 minutes you can cancel that command by calling: <code>myDevice.cancelQueuedCommands()</code>.
* '''checkFirst()''': ''Function''. Checks if the '''current''' state of the device is different than the desired new state. If the target state is the same, no command is sent. If you do <code>mySwitch.switchOn().checkFirst()</code>, then no switch command is sent if the switch is already on. This command only works with switch-like devices. It is not available for toggle and dim commands, either.
* '''forHour(hours), forMin(minutes), forSec(seconds)''': ''Function''. Activates the command for the duration of hours, minutes or seconds. See table below for applicability and the warning on unexpected behavior of these functions.
* '''withinHour(hours), withinMin(minutes), withinSec(seconds)''': ''Function''. Activates the command within a certain period (specified in hours, minutes or seconds) ''randomly''. See table below for applicability.
* '''silent()''': ''Function''. No follow-up events will be triggered: <code>mySwitch.switchOff().silent()</code>.
* '''repeatAfterHour(hours, [number]), repeatAfterMin(minutes, [number]), repeatAfterSec(seconds, [number])''': ''Function''. Repeats the sequence ''number'' times after the specified duration (specified in hours, minutes, or seconds). If no ''number'' is provided, 1 is used. '''Note that <code>afterAAA()</code> and <code>withinAAA()</code> are only applied at the beginning of the sequence and not between the repeats!'''

Note that the actual switching or changing of the device is done by Domoticz and not by dzVents. dzVents only tells Domoticz what to do; if the options are not carried out as expected, this is likely a Domoticz or hardware issue.

'''Important note when using forAAA()''': Let’s say you have a light that is triggered by a motion detector. Currently the light is <code>Off</code> and you do this: <code>light.switchOn().forMin(5)</code>. What happens inside Domoticz is this: at t0 Domoticz issues the <code>switchOn()</code> command and schedules a command to restore the '''current''' state at t5 which is <code>Off</code>. So at t5 it will switch the light off.

If, however, ''before the scheduled <code>switchOff()</code> happens at t5'', new motion is detected and you send this command again at t2 then something unpredictable may seem to happen: ''the light is never turned off!'' This is what happens:

At t2 Domoticz receives the <code>switchOn().forMin(5)</code> command again. It sees a scheduled command at t5 and deletes that command (it is within the new interval). Then Domoticz performs the (unnecessary, it’s already on) <code>switchOn()</code> command. Then it checks the current state of the light which is <code>On</code>!! and schedules a command to return to that state at t2+5=t7. So, at t7 the light is switched on again. And there you have it: the light is not switched off and never will be because future commands will always be checked against the current on-state.

That’s just how it works and you will have to deal with it in your script. So, instead of simply re-issuing <code>switchOn().forMin(5)</code> you have to check the switch’s state first:

<syntaxhighlight lang="lua">if (light.active) then
light.switchOff().afterMin(5)
else
light.switchOn().forMin(5)
end</syntaxhighlight>
or issue these two commands ''both'' as they are mutually exclusive:

<syntaxhighlight lang="lua">light.switchOff().checkFirst().afterMin(5)
light.switchOn().checkFirst().forMin(5)</syntaxhighlight>

==== Availability ====

Some options are not available to all commands. All the options are available to device switch-like commands like <code>myDevice.switchOff()</code>, <code>myGroup.switchOn()</code> or <code>myBlinds.open()</code>. For updating (usually Dummy ) devices like a text device <code>myTextDevice.updateText('zork')</code> you can only use <code>silent()</code>. For thermostat setpoint devices and snapshot command silent() is not available. For commands for which dzVents must use openURL, only <code>at()</code> and <code>afterAAA()</code> methods are available. These commands are mainly the setAaaaa() commands for RGBW type devices.

See table below

{| class="wikitable"
!width="17%"| option
!align="center" width="10%"| state changes
!align="center" width="11%"| update commands
!align="center" width="12%"| user variables
!align="center" width="12%"| updateSetpoint
!align="center" width="8%"| snapshot
!align="center" width="10%"| triggerIFTTT
!align="center" width="12%"| execute ShellCommand
!align="center" width="12%"| emitEvent
|-
| <code>afterAAA()</code>1
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>at()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>forAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>withinAAA()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| •
|-
| <code>silent()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>repeatAfterAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>checkFirst()</code>
|align="center"| • 2
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>cancelQueuedCommands()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a

|}

==== Notes on table ====

* '''Note 1''': AAA is a placeholder for <code>Min/Sec/Hour</code> affix e.g. <code>afterMin()</code>.
* '''Note 2''': for <code>domoticz.openURL()</code> only <code>at()</code>, <code>afterAAA()</code> and <code>withinAAA()</code> is available.
* '''Note 3''': Note 2 also applies for all commands depending on openURL (like rgbwwDevice.setAaa() commands).
* '''Note 4''': Including dimTo, switchSelector, setLevel and similar methods.


==== Follow-up event triggers ====

Normally if you issue a command, Domoticz will immediately trigger follow-up events, and dzVents will automatically trigger defined event scripts. If you trigger a scene, all devices in that scene will issue a change event. If you have event triggers for these devices, they will be executed by dzVents. If you don’t want this to happen, add <code>.silent()</code> to your commands (exception is updateSetPoint).


=== Create your own device adapter ===

If your device is not recognized by dzVents, you can still operate it using the generic device attributes and methods. It is much nicer, however, to have device specific attributes and methods. Existing recognized adapters are in <code>/path/to/domoticz/dzVents/runtime/device-adapters</code>. Copy an existing adapter and adapt it to your needs. You can turn debug logging on and inspect the file <code>domoticzData.lua</code> in the dzVents folder. There you will find the unique signature for your device type. Usually it is a combination of deviceType and deviceSubType, but you can use any of the device attributes in the <code>matches</code> function. The matches function checks if the device type is suitable for your adapter and the <code>process</code> function actually creates your specific attributes and methods. Also, if you call <code>myDevice.dump()</code> you will see all attributes and methods and the attribute <code>_adapters</code> shows you a list of applied adapters for that device. Finally, register your adapter in <code>Adapters.lua</code>. Please share your adapter when it is ready and working.


== Variable object API (user variables) ==

User variables created in Domoticz have these attributes and methods:


=== Variable attributes and methods ===

* '''changed''': ''Boolean''. Was the variable updated. '''Note''': update does not necessarily means the variable value or type changed.
* '''date''': ''Date''. If type is domoticz.DATE. See lastUpdate for the sub-attributes.
* '''id''': ''Number''. Index of the variable.
* '''lastUpdate''': ''[[#Time_object|Time Object]]''
* '''name''': ''String''. Name of the variable
* '''rename(newName)''': ''Function''. Change current variable name to new variable name. (does not support timing options)
* '''set(value)''': Tells Domoticz to update the variable. Supports timing options. See [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|above]].
* '''time''': ''Date''. If type is domoticz.TIME. See lastUpdate for the sub-attributes.
* '''type''': ''String''. Can be domoticz.INTEGER, domoticz.FLOAT, domoticz.STRING, domoticz.DATE, domoticz.TIME.
* '''value''': ''String|Number|Date|Time''. Value of the variable.

<syntaxhighlight lang="lua">
return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
end
end
}
</syntaxhighlight>

== Time object ==

Many attributes represent a moment in time, like <code>myDevice.lastUpdate</code> or <code>domoticz.time</code>. In dzVents, a time-like attribute is an object with properties and methods which make your life easier.

<syntaxhighlight lang="lua"> print(myDevice.lastUpdate.minutesAgo)
print(myDevice.lastUpdate.daysAgo)

-- compare two times
print(domoticz.time.compare(myDevice.lastUpdate).secs))</syntaxhighlight>
You can also create your own:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00') -- must be this format!!</syntaxhighlight>
If you don’t pass a time string:

<syntaxhighlight lang="lua"> local Time = require('Time')
local currentTime = Time()</syntaxhighlight>
Use this in combination with the various dzVents time attributes:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00')

local tonight = Time(domoticz.time.rawDate .. ' 20:00:00')
print (tonight.getISO())
-- will print something like: 2016-12-12T20:00:00Z
print(t.minutesAgo) -- difference from 'now' in minutes

-- and you can feed it with all same rules as you use
-- for the timer = { .. } section:
if (t.matchesRule('at 16:00-21:00')) then
-- t is in between 16:00 and 21:00
end

-- very powerful if you want to compare two time instances:
local anotherTime = Time('...') -- fill-in some time here
print(t.compare(anotherTime).secs) -- diff in seconds between t and anotherTime.</syntaxhighlight>

=== System event API ===

If you have a dzVents script that is triggered by a system-event in Domoticz then the second parameter passed to the execute function will be a ''system'' object. The object.type = system-event that triggered the script. ( object.isSystemEvent: true) For backups the object also contains location and durationin seconds.


=== Time properties and methods ===

Creation:

<syntaxhighlight lang="lua">local Time = require('Time')
local now = Time() -- current time
local someTime = Time('2017-12-31 22:19:15')
local utcTime = Time('2017-12-31 22:19:15', true)</syntaxhighlight>
Creation:

<syntaxhighlight lang="lua">local someTime = domoticz.time.addMinutes(30) -- someTime = domoticz time object for now + 30 minutes
local someTime = domoticz.time.makeTime() -- someTime = new domoticz time object.</syntaxhighlight>
* '''addAAA(offset)''': ''time object''. time object with given offset (positive or negative. AAA is a placeholder for <code>Seconds, Minutes, Hours or Days</code> affix e.g. `addHours(-2)
* '''civTwilightEndInMinutes''': ''Number''. Minutes from midnight until civTwilightEnd.
* '''civTwilightStartInMinutes''':''Number''. Minutes from midnight until civTwilightStart.
* '''compare(time)''': ''Function''. Compares the current time object with another time object. ''Make sure you pass a Time object!'' Returns a table (all values are ''positive'', use the compare property to see if ''time'' is in the past or future):
** '''milliseconds''': Total difference in milliseconds.
** '''seconds''': Total difference in whole seconds.
** '''minutes''': Total difference in whole minutes.
** '''hours''': Total difference in whole hours.
** '''days''': Total difference in whole days.
** '''compare''': 0 = both are equal, 1 = ''time'' is in the future, -1 = ''time'' is in the past.
* '''dateToDate( dateString, sourceFormat, targetFormat[ , offSet] )''':3.0.17 ''Function'': Returns a reformatted datestring. dateString is a formatted date and source- and targetFormat are representations of the dateString elements and their locations in the string (see examples in dateToTimestamp) . Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'dddd dd mmmm hh:MM:ss', 1 ) -- > 'Friday 31 December 23:31:06'
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'ddd dd mmm hh:MM:ss', -3600 * 24 - 3 )) -- > 'Thu 30 Dec 23:31:02'</syntaxhighlight>
* '''dateToTimestamp([ dateString [,control] ] )''': ''Function'': Returns ''Number'' representing time since epoch in seconds. dateString is a formatted date and control is a representation of the dateString elements and their location in the string. Default control is ‘yyyy-mm-dd hh:MM’. recognized controls are either a Lua pattern string or a string containing following codes:

<syntaxhighlight lang="lua"> dddd -- full weekdayname(e.g. Wednesday) language depends on locale
ddd -- abbreviated weekdayname(e.g. Wed) language depends on locale
dd -- day of the month {[01-31]
mmmm -- full monthname(e.g September) language depends on locale
mmm -- abbreviated monthname(e.g. Sep) language depends on locale
mm -- month [01-12]
yyyy -- 4 digit year
yy -- 2 digit year
hh -- hour 24-hour clock
ii -- hour 12-hour clock
MM -- minute
ss -- second
W -- weeknumber [01-53]
w -- weekday{[0-6] Sunday-Saturday
datm -- date and time (e.g. 09/16/98 23:48:10) format depends on locale
mer -- either "AM" or "PM" locale
date -- date(e.g. 09/16/98) format depends on locale
time -- time (e.g. 23:48:10)

-- examples:
domoticz.time.dateToTimestamp('2020-12-31 23:59')) -- > 1609455540
domoticz.time.dateToTimestamp('2020-12-31 23:59:01','yyyy-mm-dd hh:MM:ss')) -- > 1609455541
domoticz.time.dateToTimestamp('December 31, 23:59:02','mmmm dd, hh:MM:ss')) -- > 1609455542
domoticz.time.dateToTimestamp('2020-12-31 23:59:03','(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)' )) -- > 1609455543
domoticz.time.dateToTimestamp('20201231235904','(%d%d%d%d)(%d%d)(%d%d)(%d%d)(%d%d)(%d%d)')) -- > 1609455544</syntaxhighlight>
* '''day''': ''Number''
* '''dayAbbrOfWeek''': ''String''. sun,mon,tue,wed,thu,fri or sat
* '''daysAgo''': ''Number''
* '''dayName''': ''String''. complete name Sunday, Monday, etc
* '''dDate''': ''Number''. timestamp (seconds since 01/01/1970 00:00)
* '''getISO''': ''Function''. Returns the ISO 8601 formatted date.
* '''hour''': ''Number''
* '''hoursAgo''': ''Number''. Number of hours since the last update.
* '''isdst''': ''Boolean''. 3.0.18 Indicates if time is in the daylight saving period
* '''isToday''': ''Boolean''. Indicates if time is today
* '''isUTC''': ''Boolean''.
* '''makeTime(string | table,[isUTC])''': ''domoticz time object''. returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. isUTC defaults to false.
* '''matchesRule(rule) ''': ''Function''. Returns true if the rule matches with the time. See [[#timer_trigger_rules|time trigger rules]] for rule examples.
* '''millisecondsAgo''': ''Number''. Number of milliseconds since the last update.
* '''minutes''': ''Number''
* '''minutesAgo''': ''Number''. Number of minutes since the last update.
* '''minutesSinceMidnight''': ''Number''
* '''month''': ''Number''
* '''monthAbbrName''': String. jan, feb, mar, etc
* '''monthName''': ''String''. January, February, etc
* '''msAgo''': ''Number''. Number of milliseconds since the last update.
* '''raw''': ''String''. Generated by Domoticz
* '''rawDate''': ''String''. Returns the date part of the raw data.
* '''rawDateTime''': ''String''. Combined date / time formatted as domoticz does in API / JSON returns (rawDate .. ’ ’.. rawTime )
* '''rawTime''': ''String''. Returns the time part of the raw data as HH:MM:SS
* '''seconds''': ''Number''
* '''secondsSinceMidnight''': ''Number''
* '''secondsAgo''': ''Number''. Number of seconds since the last update.
* '''sunsetInMinutes''': ''Number''. Minutes from midnight until sunset.
* '''sunriseInMinutes''': ''Number''. Minutes from midnight until sunrise.
* '''solarnoonInMinutes''': ''Number''. 3.0.11 Minutes from midnight until solarnoon.
* '''time''': ''String''. Returns the time part of the raw data as HH:MM
* '''timestampToDate([ [ timestamp ] , [ pattern ] ,[ offSet ] )''': ''function''. Returns a datestring. timestamp is number of seconds since epoch (default = now) , pattern is a string as explained in this wiki at the description of the domoticz.time.dateToTimestamp function (default = ‘yyyy-mm-dd hh:MM:ss’). Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.timestampToDate(10,'date time') --> '01/01/70 01:00:10'
domoticz.time.timestampToDate(60,'ddd mm mmm yyyy ii:MM mer','date time') --> 'Thu 01 Jan 1970 01:01 AM''
domoticz.time.timestampToDate(1598077445,'dd/mm/yy ii:MM mer nZero') --> '22/08/20 8:24 AM'</syntaxhighlight>
* '''toUTC(string | table,[offset])''': ''domoticz time object''. 3.0.9 returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. offset defaults to 0.
* '''utcSystemTime''': ''Table''. UTC system time (only when in UTC mode):
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''utcTime''': ''Table''. Time stamp in UTC time:
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''year''': ''Number''
* '''wday''': ''Number'' day of the week. Sunday = 1, Saturday = 7
* '''week''': ''Number'' week of the year

'''Note: it is currently not possible to change the domoticz.time object instance.''' ( but you can create a new one with- or without an offset)


== Shared helper functions ==

It is not unlikely that at some point you want to share Lua code among your scripts. Normally in Lua you would have to create a module and require that module in all you scripts. But dzVents makes that easier for you: Inside your scripts folder or in Domoticz’ GUI web editor, create a <code>global_data.lua</code> script (same as for global persistent data) and feed it with this code:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(param1, param2)
-- do your stuff
end,
MY_CONSTANT = 100 -- doesn't have to be a function
}
}</syntaxhighlight>
Save the file and then you can use myHandyFunction everywhere in your event scripts:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction('bla', 'boo')
print(domoticz.helpers.MY_CONSTANT)
end
}</syntaxhighlight>
No <code>require</code> or <code>dofile</code> is needed.

'''Important note: if you need to access the domoticz object in your helper function you have to pass it as a parameter:'''

Example:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(domoticz, param1, param2)
-- do your stuff
domoticz.log('Hey')
end
}
}</syntaxhighlight>
And pass it along:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction(domoticz, 'bla', 'boo')
end
}</syntaxhighlight>
'''Note''': there can be only '''one''' <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.


== Requiring your own modules ==

If you don’t want to use the helpers support, but you want to require your own modules, place them either in <code>/path/to/domoticz/scripts/dzVents/modules</code> or <code>/path/to/domoticz/scripts/dzVents/scripts/modules</code> as these folders are already added to the Lua package path. You can just require those modules: <code>local myModule = require('myModule')</code>


= Persistent data =

In many situations you need to store a device state or other information in your scripts for later use. Like knowing what the state was of a device the previous time the script was executed or what the temperature in a room was 10 minutes ago. Without dzVents, you had to resort to user variables. These are global variables that you create in the Domoticz GUI and that you can access in your scripts like: domoticz.variables(‘previousTemperature’).

Now, for some this is rather inconvenient and they want to control this state information in the event scripts themselves or want to use all of Lua’s variable types. dzVents has a solution for that: '''persistent script data'''. This can either be on the script level or on a global level.


== Script level persistent variables ==

The values in persistent script variables persist and can be retrieved in the next script run.

For example, send a notification if a switch has been activated 5 times:

<syntaxhighlight lang="lua"> return {
on = {
devices = { 'MySwitch' }
},
data = {
counter = { initial = 0 }
},
execute = function(domoticz, switch)
if (domoticz.data.counter == 5) then
domoticz.notify('The switch was pressed 5 times!')
domoticz.data.counter = 0 -- reset the counter
else
domoticz.data.counter = domoticz.data.counter + 1
end
end
}</syntaxhighlight>
The <code>data</code> section defines a persistent variable called <code>counter</code>. It also defines an initial value. From then on you can read and set the variable in your script.

You do not have to provide an initial value though. In that case the initial value is ''nil'':

<syntaxhighlight lang="lua"> return {
--
data = {
'x', 'y', 'z' -- note the quotes
},
execute = function(domoticz, item)
print(tostring(domoticz.data.x)) -- prints nil
end
}</syntaxhighlight>
You can define as many variables as you like and put whatever value in there that you like. It doesn’t have to be just a number. Just don’t put something in there with functions (well, they are filtered out actually).


=== Size matters and watch your speed!! ===

If you include tables (or arrays) in the persistent data, beware to not let them grow. It will definitely slow down script execution because dzVents has to serialize and deserialize the data. It is better to use the historical option as described below.


=== Re-initializing a variable ===

You can re-initialize a persistent variable and re-apply the initial value as defined in the data section:

<syntaxhighlight lang="lua">return {
on = { .. },
data = {
x = { initial = 'initial value' }
},
execute = function(domoticz, item)
if (domoticz.data.x ~= 'initial value') then
domoticz.data.initialize('x')
print(domoticz.data.x) -- will print 'initial value'
end
end
}</syntaxhighlight>
Note that <code>domoticz.data.initialize('<varname>')</code> is just a convenience method. You can of course create a local variable in your module holding the initial value and use it in your data section and your execute function.


== Global persistent variables ==

Script level variables are only available in the scripts that define them, but global variables can be accessed and changed in every script. To utilize global persistent variables, create a script file called <code>global_data.lua</code> in your scripts folder with this content (same file where you can also put your shared helper functions):

<syntaxhighlight lang="lua"> return {
helpers = {},
data = {
peopleAtHome = { initial = false },
heatingProgramActive = { initial = false }
}
}</syntaxhighlight>
Just define the variables that you need and access them in your scripts:

<syntaxhighlight lang="lua"> return {
on = {
devices = {'WindowSensor'}
},
execute = function(domoticz, windowSensor)
if (domoticz.globalData.heatingProgramActive
and windowSensor.state == 'Open') then
domoticz.notify("Hey don't open the window when the heating is on!")
end
end
}</syntaxhighlight>
'''Note''': there can be only one <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.

You can use <code>domoticz.globalData.initialize('<varname>')</code> just as like <code>domoticz.data.initialize('<varname>')</code>.


== A special kind of persistent variables: ''history = true'' (Historical variables API) ==

In some situations, storing a previous value for a sensor is not enough, and you would like to have more previous values. For example, you want to calculate an average over several readings. Of course you can define a persistent variable holding a table:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
previousData = { initial = {} }
},
execute = function(domoticz, sensor)
-- add new data
table.insert(domoticz.data.previousData, sensor.temperature)

-- calculate the average
local sum = 0, count = 0
for i, temp in pairs(domoticz.data.previousData) do
sum = sum + temp
count = count + 1
end
local average = sum / count
end
}</syntaxhighlight>
The problem with this is that you have to do a lot of bookkeeping to make sure that there isn’t too much data to store (see [[#How_does_the_storage_stuff_work.3F|below for how it works]]) . Fortunately, dzVents has done this for you:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
temperatures = { history = true, maxItems = 10 }
},
execute = function(domoticz, sensor)
-- add new data
domoticz.data.temperatures.add(sensor.temperature)

-- average
local average = domoticz.data.temperatures.avg()

-- maximum value in the past hour:
local max = domoticz.data.temperatures.maxSince('01:00:00')
end
}</syntaxhighlight>

=== Defining ===

Define a script variable or global variable in the data section and set <code>history = true</code>:

<syntaxhighlight lang="lua"> …
data = {
var1 = { history = true, maxItems = 10, maxHours = 1, maxMinutes = 5 }
}</syntaxhighlight>
* '''maxItems''': ''Number''. Controls how many items are stored in the variable. maxItems has precedence over maxHours and maxMinutes.
* '''maxHours''': ''Number''. Data older than <code>maxHours</code> from now will be discarded. E.g., if set to 2, then data older than 2 hours will be removed at the beginning of the script.
* '''maxMinutes''': ''Number''. Same as maxHours but, you guessed it: for minutes this time.. All these options can be combined. '''Reminder: don’t store too much data. Only put in what you really need!'''


=== Adding data ===

Add new values to a historical variable:

<pre>domoticz.data.myVar.add(value)</pre>
As soon as this new value is put on top of the list, the older values shift one place down the line. If <code>maxItems</code> is reached, then the oldest value will be discarded. ''All methods, like calculating averages or sums, will immediately use this new value!'' If you don’t want this to happen, set the new value at the end of your script or after you have done your analysis.

Any kind of data may be stored in the historical variable: numbers, strings, but also more complex data like tables. However, in order to use the [[#Statistical_functions|statistical methods]], numeric values are required.


=== Accessing values in historical variables ===

Values in a historical variable are indexed, where index 1 is the newest value, 2 is the second newest, and so on:

<pre>local item = domoticz.data.myVar.get(5)
print(item.data)</pre>
However, all data in the storage are time-stamped:

<pre>local item = domoticz.data.myVar.getLatest()
print(item.time.secondsAgo) -- access the time stamp
print(item.data) -- access the data</pre>
The time attribute by itself is a table with many properties that help you inspect the data points more easily. See [[#Time_object|Time Object]] for all attributes and methods.


==== Index ====

All data in the set can be addressed using an index. The item with index = 1 is the youngest, and the item with the highest index is the oldest. Beware, if you have called <code>add()</code> first, then the first item is that new value! You can always check the size of the set by inspecting <code>myVar.size</code>.


==== Time specification (''timeAgo'') ====

Every data point in the set has a timestamp and the set is ordered so that the youngest item is the first and the oldest item the last. Many functions require a moment in the past to be specified by passing a string in the format '''<code>hh:mm:ss</code>''', where ''hh'' is the number of hours ago, ''mm'' the number of minutes and ''ss'' the number of seconds. The times are added together, so you don’t have to consider 60 minute boundaries, etc. A time specification of <code>12:88:03</code> is valid, and points to the data point at or around <code>12*3600 + 88*60 + 3 = 48.483 seconds</code> in the past.

Example:

<pre>-- get average for the past 30 minutes:
local avg = myVar.avgSince('00:30:00')</pre>

==== Getting data points ====

* '''get(idx)''': Returns the idx-th item in the set. Same as <code>myVar.storage[idx]</code>.
* '''getAtTime([[#Time_specification_.28timeAgo.29|timeAgo]])''': Returns the data point ''closest'' to the moment as specified by <code>timeAgo</code> and the index in the set. So, <code>myVar.getAtTime('1:00:00')</code> returns the item that is closest to one hour old. It may be a bit younger or a bit older than 1 hour. The second return value is the index in the set: <code>local item, index = myVar.getAtTime('1:00:00')</code>
* '''getLatest( )''': Returns the youngest item in the set. Same as <code>print(myVar.get(1).data)</code>.
* '''getOldest( )''': Returns the oldest item in the set and the index. Same as <code>print(myVar.get(myVar.size).data)</code>. Note that the index is always the same as the total size. <code>local item, index = myVar.getOldest()</code>.
* '''size''': Return the number of data points in the set.
* '''subset( [fromIdx], [toIdx] )''': Returns a subset of the stored data. Default value, if omitted, of <code>fromIdx</code> is 1. Omitting <code>toIdx</code> takes all items until the end of the set (oldest). E.g., <code>myVar.subset()</code> returns all data. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''subsetSince( [[#Time_specification_.28timeAgo.29|timeAgo]] )''': Returns a subset of the stored data since the relative time specified by timeAgo. So calling <code>myVar.subsetSince('00:60:00')</code> returns all items that have been added to the list in the past 60 minutes. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''reset( )''': Removes all the items from the set. It could be a good practice to do this often when you know you don’t need older data. For instance, when you turn on a heater and you just want to monitor rising temperatures starting from this moment when the heater is activated. If you don’t need data points from before, then you may call reset.


==== Looping through the data: iterators ====

Similar to the iterators as described [[#Looping_through_the_collections:_iterators|above]], there are convenience methods to make looping through the data set easier.

* '''forEach(function)''': Loop over all items in the set: E.g.: <code>myVar.forEach( function( item, index, collection) ... end )</code>
* '''filter(function)''': Create a filtered set of items. The function receives the item and returns true if the item is in the result set. E.g. get a set with item values larger than 20: <code>subset = myVar.filter( function (item) return (item.data > 20) end )</code>.
* '''find(function)''': Search for a specific item in the set: E.g. find the first item with a value higher than 20: <code>local item = myVar.find( function (item) return (item.data > 20) end )</code>.
* '''reduce(function, initial)''': Loop over all items in the set and do some calculation with it. You call reduce with the function and the initial value. Each iteration the function is called with the accumulator. The function does something with the accumulator and returns a new value for it. Once you get the hang of it, it is very powerful. Best to give an example. To sum all values:

<syntaxhighlight lang="lua"> local sum = myVar.reduce(function(acc, item)
local value = item.data
return acc + value
end, 0)</syntaxhighlight>
Suppose you want to get data points older than 45 minutes and count the values that are higher than 20 (of course there are more ways to do this):

<syntaxhighlight lang="lua"> local myVar = domoticz.data.myVar

local olderItems = myVar.filter(function (item)
return (item.time.minutesAgo > 45)
end)

local count = olderItems.reduce(function(acc, item)
if (item.data > 20) then
acc = acc + 1
end
return acc
end, 0)

print('Found ' .. tostring(count) .. ' items')</syntaxhighlight>

==== Statistical functions ====

Statistical functions require ''numerical'' data in the set. If the set is just numbers you can do this:

<pre>myVar.add(myDevice.temperature) -- adds a number to the set
myVar.avg() -- returns the average</pre>
If, however, you add more complex data or you want to do a computation first, then you have to ''tell dzVents how to get a numeric value from these data''. So let’s say you do this to add data to the set:

<pre>myVar.add( { 'person' = 'John', waterUsage = u })</pre>
Where <code>u</code> is a variable that got its value earlier. If you want to calculate the average water usage, then dzVents will not be able to do this because it doesn’t know the value is actually in the <code>waterUsage</code> attribute! You will get <code>nil</code>.

To make this work you have to provide a '''getValue function''' in the data section when you define the historical variable:

<syntaxhighlight lang="lua"> return {
active = true,
on = {...},
data = {
myVar = {
history = true,
maxItems = 10,
getValue = function(item)
return item.data.waterUsage -- return number!!
end
}
},
execute = function()...end
}</syntaxhighlight>
This function tells dzVents how to get the numeric value for a data item. '''Note: the <code>getValue</code> function has to return a number!'''.

Of course, if you don’t intend to use any of these statistical functions you can put whatever you want in the set.

<ul>
<li>'''avg( [fromIdx], [toIdx], [default] )''': Calculates the average of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''avgSince([[#Time_specification_.28timeAgo.29|timeAgo]], default )''': Calculates the average of all data points since <code>timeAgo</code>. Returns <code>default</code> if there are no data, otherwise 0. E.g.: <code>local avg = myVar.avgSince('00:30:00')</code> returns the average over the past 30 minutes.</li>
<li>'''med( [fromIdx], [toIdx], [default] )''': Calculates the median of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''min( [fromIdx], [toIdx] )''': Returns the lowest value in the range defined by fromIdx and toIdx.</li>
<li>'''minSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''min''' but now within the <code>timeAgo</code> interval.</li>
<li>'''max( [fromIdx], [toIdx] )''': Returns the highest value in the range defined by fromIdx and toIdx.</li>
<li>'''maxSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''max''' but within the <code>timeAgo</code> interval.</li>
<li>'''sum( [fromIdx], [toIdx] )''': Returns the summation of all values in the range defined by fromIdx and toIdx. It will return 0 when there are no data.</li>
<li>'''sumSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''sum''' but within the <code>timeAgo</code> interval. It will return 0 when there are no data in the interval.</li>
<li>** delta(fromIdx, toIdx, [smoothRange], [default] )**: Returns the delta (difference) between items specified by <code>fromIdx</code> and <code>toIdx</code>. Provide a valid range (no <code>nil</code> values). [Supports data smoothing]. (#Data_smoothing) when providing a <code>smoothRange</code> value. Returns <code>default</code> if there is not enough data. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta(2, 5, 3)</code>.</li>
<li>'''delta2( fromIdx, toIdx, [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''delta''' but now you can control if the smooth values for the ''from-item'' and the ''to-item'' separately. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta2(2, 5, 3, 3)</code>.</li>
<li>'''deltaSince([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRange], [default] )''': Same as '''delta''' but within the <code>timeAgo</code> interval. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSince('00:00:10', 3)</code>.</li>
<li>'''deltaSinceOrOldest([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''deltaSince''' but it will take the oldest value in the set if ''timeAgo'' is older than the age of the entire set. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSinceOrOldest('00:00:10', 3, 3)</code>.</li>
<li>'''localMin( [smoothRange], default )''':</li>
<li>'''localMin( [smoothRange], default )''': Returns the first minimum value (and the item holding the minimal value) in the past. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value. For example, given this range of values in the data set (from new to old): <code>10 8 7 5 3 4 5 6</code>, it will return <code>3</code> because older values ''and'' newer values are higher: a local minimum. Use this if you want to know at what time a temperature started to rise after it had been dropping. E.g.:
<pre> local value, item = myVar.localMin()
print(' minimum was : ' .. value .. ': ' .. item.time.secondsAgo .. ' seconds ago' )</pre></li>
<li>'''localMax([smoothRange], default)''': Same as '''localMin''' but for the maximum value. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value.</li>
<li>'''smoothItem(itemIdx, [smoothRange])''': Returns a the value of <code>itemIdx</code> in the set but smoothed by averaging with its neighbors. The number of neighbors is set by <code>smoothRange</code>. See [[#Data_smoothing|Data smoothing]].</li></ul>


==== Data smoothing ====

Example: Suppose you store temperatures in the historical variable. These temperatures may have extremes. Perhaps these extremes could be due to sensor reading errors. In order to reduce the effect of these so-called spikes, you could smooth out values. It is like blurring the data. The Raw column is your temperatures. The other columns are calculated by averaging the neighbors. For item 10 the calculations are:

<pre>Range=1 for time10 = (25 + 31 + 29) / 3 = 28,3
Range=2 for time10 = (16 + 25 + 31 + 29 + 26) / 5 = 25,4</pre>

{| class="wikitable" style="text-align: center; align="center" width="30% height:10px;"
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"| time
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| raw
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=1
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=2
|-
| '''1'''
| 18
| 20,0
| 21,7
|-
| '''2'''
| 22
| 21,7
| 25,0
|-
| '''3'''
| 25
| 27,3
| 24,6
|-
| '''4'''
| 35
| 27,7
| 26,6
|-
| '''5'''
| 23
| 28,7
| 27,6
|-
| '''6'''
| 28
| 26,0
| 25,8
|-
| '''7'''
| 27
| 23,7
| 23,8
|-
| '''8'''
| 16
| 22,7
| 25,4
|-
| '''9'''
| 25
| 24,0
| 25,6
|-
| '''10'''
| 31
| 28,3
| 25,4
|-
| '''11'''
| 29
| 28,7
| 29,2
|-
| '''12'''
| 26
| 30,0
| 30,2
|-
| '''13'''
| 35
| 30,3
| 30,2
|-
| '''14'''
| 30
| 32,0
| 30,4
|-
| '''15'''
| 31
| 30,3
| 30,8
|-
| '''16'''
| 30
| 29,7
| 28,2
|-
| '''17'''
| 28
| 26,7
| 28,6
|-
| '''18'''
| 22
| 27,3
| 26,2
|-
| '''19'''
| 32
| 24,3
| 25,3
|-
| '''20'''
| 19
| 25,5
| 24,3
|}
A chart illustrates it more clearly. The red line is not smoothed and has more spikes than the others:

[[File:dzvents-smoothing.png|frame|none|alt=|Smoothing]]

Usually a range of 1 or 2 is sufficient when providing a smoothing range to statistical functions. I suggest smoothing when checking deltas, local minimums and maximums.


== How does the storage stuff work? ==

For every script file that defines persisted variables (using the <code>data={ … }</code> section), dzVents will create storage file with the name <code>__data_scriptname.lua</code> in a subfolder called <code>data</code>. You can always delete these data files or the entire storage folder if there is a problem with it:

<pre>domoticz/
scripts/
dzVents/
data/
__data_yourscript1.lua
__data_yourscript2.lua
__data_global_data.lua
examples/
generated_scripts/
scripts/
yourscript1.lua
yourscript2.lua
global_data.lua</pre>
If you dare to, you can watch inside these files. Every time some data are changed, dzVents will stream the changes back into the data files. '''Again, make sure you don’t put too much stuff in your persistent data as it may slow things down too much.'''


= Asynchronous HTTP requests =

dzVents allows you to make asynchronous HTTP request and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use os functions like <code>curl</code> or <code>wget</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz will terminate the script with a message that it took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to make an http call and it is determined by how you use the <code>domoticz.openURL()</code> command. The simplest form simply calls <code>openURL</code> on the domoticz object with only the url as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.openURL('http://domain/path/to/something?withparameters=1')</syntaxhighlight>
After your script is finished, Domoticz will make the request that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a url you pass in a table with all the parameters to make the request '''and''' your provide a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.openURL({
url = 'http://domain/path/to/something',
method = 'POST',
callback = 'mycallbackstring',
postData = {
paramA = 'something',
paramB = 'something else'
}
})
end
}</syntaxhighlight>
In this case, Domoticz will make the request (a POST in this case), and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
httpResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if (response.ok) then -- success
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every 5 seconds'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = '...',
callback = 'trigger'
})
end
if (item.isHTTPResponse) then
if (item.ok) then
...
end
end
end
}</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.openURL(options)''': ''options'' is a Lua table:

* '''url''': ''String''.
* '''method''': ''String''. Optional. Either <code>'GET'</code> (default), <code>'POST'</code>, <code>'PUT'</code>3.0.2 or <code>'DELETE'</code>3.0.2 .
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to trigger the callback handler script(s).
* '''headers''': ''Table / String''. Optional. A Lua table or JSON string with additional http request-headers.
* '''postData''': ''Table / String''. Optional. When doing a <code>POST</code>, <code>PUT</code> 3.0.2 or <code>DELETE</code>3.0.2 this data will be the payload of the request (body). If you provide a Lua table then this will automatically be converted to json and the request-header <code>application/json</code> is set. So no need to do that manually. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': Raw response data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''headers''': ''Table''. Response headers.
* '''isJSON''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'application/json'</code>. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'text/xml'</code>. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be in range of 200-299.
* '''statusCode''': ''Number''. HTTP status codes. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''statusText''': ''String''. HTTP status message. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''protocol''': ''String''. HTTP protocol. See [https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP response status codes].
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


=== More about request and response headers ===

Whenever you do an http request it is not just some data that is sent. Along with the request a bunch of so-called headers are sent along with it. HTTP headers allow the client and the server to pass additional information with the request or the response. Also, in the response there are also headers (response header). These response headers usually tell you what kind of data is returned, if it is compressed, if the request was successful etc.


==== request headers ====

dzVents allow you to set custom request headers that will accompany the data in the request. Sometimes it is necessary to set these headers like for instance when a API or webservice require a security token or key or when the service needs to know what the format of the response data is. Check the documentation of the web service.

So, let’s say you need to call a web service that requires an api key in the headers and the documentation states it needs to be passed in an x-access-token header. Your openURL command then may look like this:

<syntaxhighlight lang="lua">domoticz.openURL({
url = 'https://somedomain.com/service/getInfo',
headers = { ['x-access-token'] = '<api-key>' },
method = 'GET',
callback = 'info'
})</syntaxhighlight>
Check google for more information about request headers. All you need to know here is that dzVents allow you to set these headers.


==== response headers ====

As said earlier, the response also contains a bunch of headers. You can inspect those headers with dzVents but ususally you don’t have to. For starters, dzVents already checks the <code>Content-Type</code> header which usually states what kind of data format the response is. If it is <code>application/json</code> then it automatically converts the json data to a Lua table. Also, it checks the <code>Status</code> header to see if the request was successful. If so, then it sets the <code>ok</code> attribute on the response object. So normally you don’t have to inspect the headers. However, sometimes the web service puts a session token in the response header that you have to use in follow-up requests.

So here an example where we have to log in before we can fetch data. It uses two requests: the first performs the log-in and the second grabs the session token from the login response data and uses that token in the second request to get the data we need. In this example we do this every hour.

That would look like this:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'loggedin', 'data' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/login',
method = 'POST',
postData = { ['username'] = 'Luke Skywalker', ['password'] = 'theforce' }
callback = 'loggedin'
})
end
if (item.isHTTPResponse and item.ok) then
-- check to which request this response was the result
if (item.trigger == 'loggedin') then
-- we are logged in, now grab the session token from the header and
-- fetch our data
local token = item.headers['x-session-token']
-- now we have the token, put it in the headers:
domoticz.openURL({
url = 'https://somedomain.com/getData',
method = 'GET',
headers = { ['x-session-token'] = token },
callback = 'data'
})
else
-- it must the data we requested
local data = item.data
-- do something with it
end
end
end
}</syntaxhighlight>
Some remarks about the response header <code>Content-Type</code>. If a service is a good web-citizen then it tells you what the format of the data is in this header. So, if the data is a json object then the header should be <code>application/json</code>. Unfortunately, there are lot of lazy programmers out there who don’t set this header properly. If that is the case, dzVents cannot detect the format and will not turn it into a Lua table for you automatically. So, if you know it is json but the header is not properly set, then you can easily convert it into a Lua table in your code:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/getData',
callback = 'trigger'
})
end
if (item.isHTTPResponse and item.ok) then
-- we know it is json but dzVents cannot detect this
-- convert to Lua
local json = domoticz.utils.fromJSON(item.data)
-- json is now a Lua table
print(json.result.title) -- just an example
end
end
}</syntaxhighlight>

= Asynchronous shell command execution =

dzVents allows you to make asynchronous shell commands and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use functions like <code>utils.osCommand()</code> or <code>os.Execute()</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz comes with a message that the script took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to execute a shell command asynchronously and it is determined by how you use the <code>domoticz.executeShellCommand()</code> command. The simplest form simply calls <code>executeShellCommand</code> on the domoticz object with only the command as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.executeShellCommand('some shell command')</syntaxhighlight>
After your script is finished, Domoticz will execute the request in a separate thread and that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a command you pass in a table with the command to be executed '''and''' a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.executeShellCommand({
command = 'some shell command',
callback = 'mycallbackstring',
timeout = timeoutinseconds,
})
end
}</syntaxhighlight>
In this case, Domoticz will execute the command and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
shellCommandResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if response.ok then
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every 5 minutes',
},
shellCommandResponses =
{
scriptVar,
},
},

execute = function(domoticz, item)
if item.isTimer then
domoticz.executeShellCommand(
{
command = 'some shell command',
callback = scriptVar,
timeout = timeoutinseconds,
})
elseif item.isShellCommandResponse then
if item.statusCode == 0 then
... -- process result (in item.json, -item.xml, -item.lines or item.data)
end
end
end
}
</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.executeShellCommand(options)''': ''options'' is a Lua table:

* '''command''': ''String''.
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to find a the callback handler script.
* '''timeout''': ''Integer''. Optional. Max execution time in seconds. defaults to 10 seconds. A value of 0 disables the timeout.

Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': output from the command. (stdout)
* '''errorText''': Errors generated by the command (stderr)
* '''statusCode''': ''Int''. exitcode generated by the command
* '''hasLines''': ''Boolean''. When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''json''': ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be 0.
* '''timeoutOccurred''' ''Boolean'' <code>True</code> when the request was aborted by a timeout.
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


= Settings =

Settings for dzVents are found in the Domoticz GUI: '''Setup > Settings > Other > EventSystem''':

* '''dzVents disabled''': Tick this if you don’t want any dzVents script to be executed.
* '''Log level''': (Note that you can override this setting in the logging section of your script)
** ''Errors'',
** ''Errors + minimal execution info'': Errors and some minimal information about which script is being executed and why,
** ''Errors + minimal execution info + generic info''. Even more information about script execution and a bit more log formatting.
** ''Debug''. Shows everything and dzVents will create the files <code>domoticzData.lua</code> and <code>module.log</code> in the scripts/dzVents folder. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz and <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.
** ''No logging''. As silent as possible.


= Troubleshooting =

So, you think if you have done everything correctly but things do not work (in some way) as you expected. Here are a couple steps you can do to find the cause.


=== Is dzVents enabled? ===

Check the settings (see above) and make sure the checkbox '''dzVents disabled''' is not checked.


=== Is your script enabled? ===

Make sure the active section in your script is set to <code>true</code>: <code>active = true</code>. And, on top of that, if you are using the internal web editor to write your script, make sure that your script is active there and you have clicked Save! “Event active” is a separate checkbox that must be ticked for every active script. When not active, the script name will be red in the list on the right.


=== Turn on debug logging ===

Activate debug logging in the settings (see above). This will produce a lot of extra messages in the Domoticz log (don’t forget to turn it off when you are done troubleshooting!). It is best to monitor the log through the command line, as the log in the browser sometimes tends to not always show all log messages. See the Domoticz manual for how to do that.

When debug logging is enabled, every time dzVents kicks into action (Domoticz throws an event) it will log it, and it will create the files <code>domoticzData.lua</code> and <code>module.log</code> in <code>/path/to/domoticz/scripts/dzVents</code>. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz. This data lie at the core of the dzVents object model. You can open this file in an editor to see if your device/variable/scene/group/hardware is in there. Note that the data in the file are not exactly the same as what you will get when you interact with dzVents, but it is a good start. If your object is not in the data file, then you will not have access to it in dzVents and dzVents will not be able to match triggers with that object. Something’s wrong if you expect your object to be in there but it is not (is the object active/used?). <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.with a dump of the data sent to dzVents.

Example content of <code>module.log</code>

<pre> Startdate time - End date time (clk - CPU ) dule / scriptname << type: "trigger"
---------------------------------------------------------------------------------------------------------------
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0029) waqi.lua << timer: "every 20 minutes"
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0016) Washer.lua << timer: "every 5 minutes"
11/27/20 18:40:01 - 11/27/20 18:40:01 (00 - 0.0215) getWaterFromHomewizard.lua << HTTPResponse: "WaterfromHomewizard"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.2472) updateWeatherSensors.lua << HTTPResponse: "WUS_buienradarResponse"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.0290) waqi.lua << HTTPResponse: "waqi_nearby"
11/27/20 18:41:00 - 11/27/20 18:41:00 (00 - 0.0583) Bathroom humidity.lua << timer: "every minute between 05:15 and 23:30"</pre>
Every time Domoticz starts dzVents and debug logging is enabled you should see these lines in the domoticz log:

<pre>dzVents version: x.y.z
Event trigger type: aaaa</pre>
Where aaaa can be time, custom event, system event, device, uservariable, security or scenegroup. That should give you a clue what kind of event is active. If you don’t see this information then dzVents is not active (or debug logging is not active).


=== Script is still not executed ===

If for some reason your script is not executed while all of the above is done, it is possible that your triggers are not correct. Either the time rule is not matching with the current time (try to set the rule to <code>every minute</code> or something simple), or the device name is not correct (check casing), or you use an id that doesn’t exist. Note that in the <code>on</code> section, you cannot use the dzVents domoticz object!

Make sure that if you use an id in the <code>on</code> section that this id is correct. Go to the device list in Domoticz and find the device and make sure the device is in the ‘used’ list!. Unused devices will not create an event. Find the idx for the device and use that as the id.

Also, make sure that your device names are unique! dzVents will throw a warning in the log if multiple device names match. It’s best practice to have unique names for your devices. Use some clever naming like prefixing like ‘Temperature: living room’ or ‘Lights: living room’. That also makes using wild cards on your <code>on</code> section easier.

If your script is still not triggered, you can try to create a classic Lua event script and see if that does work.


=== Debugging your script ===

A simple way to inspect a device in your script is to dump it to the log: <code>myDevice.dump()</code>. This will dump everything known to dzVents of the device so you can inspect what its state is. If you only need to see a subset you can use dumpSelection(‘attributes’), dumpSelection(‘functions’) or dumpSelection(‘tables’) Use print statements or domoticz.log() statements in your script at cricital locations to see if the Lua interpreter reaches that line. Don’t try to print a device object though; use the <code>myDevice.dump()</code> method for that. It wil log all attributes of the device in the Domoticz log.

If you place a print statement all the way at the top of your script file it will be printed every time dzVents loads your script (that is done at the beginning of each event cycle). Sometimes that is handy to see if your script gets loaded in the first place. If you don’t see your print statement in the log, then likely dzVents didn’t load it and it will not work.


=== Get help ===

The Domoticz forum is a great resource for help and solutions. Check the [https://www.domoticz.com/forum/viewforum.php?f=59 dzVents forum].


= Other interesting stuff =


== lodash for Lua ==

lodash is a well known and very popular Javascript library filled with dozens of handy helper functions that really make you life a lot easier. Fortunately there is also a Lua version. This is directly available through the domoticz object:

<syntaxhighlight lang="lua">local _ = domoticz.utils._
_.print(_.indexOf({2, 3, 'x', 4}, 'x'))</syntaxhighlight>

Check out the documentation [https://htmlpreview.github.io/?https://github.com/rwaaren/lodash.lua/blob/master/doc/index.html here].


= History [https://wiki.domoticz.com/DzVents_version_History link to changes in previous versions]. =

See link for the complete list of changes

https://wiki.domoticz.com/DzVents_version_History

DzVents: next generation Lua scripting

2026-08-02T17:06:17Z

Walter vl: /* Thermostat 6 3.1.11 */

'''Note''': This document is maintained on [https://github.com/domoticz/domoticz/blob/development/dzVents/documentation/README.md github], and the wiki version is automatically generated. Edits should be performed on github, or they may be suggested on the wiki article’s [https://wiki.domoticz.com/Talk:DzVents:_next_generation_Lua_scripting Discussion page]. Editing can be done by any editor but if you are looking for a specialized markDown editor; [https://stackedit.io/app# stackedit.io] would be a good choice.


= About dzVents =

dzVents /diː ziː vɛnts/, short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts. And … '''it is 100% Lua'''! So if you already have a bunch of event scripts for Domoticz, upgrading should be fairly easy.

Let’s start with an example. Say you have a switch that when activated, it should activate another switch but only if the room temperature is above a certain level. And when done, it should send a notification. This is how it looks in dzVents:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'Room switch'}
},

execute = function(domoticz, roomSwitch)
if (roomSwitch.active and domoticz.devices('Living room').temperature > 18) then
domoticz.devices('Another switch').switchOn()
domoticz.notify('This rocks!',
'Turns out that it is getting warm here',
domoticz.PRIORITY_LOW)
end

}</syntaxhighlight>
Or you have a timer script that should be executed every 10 minutes, but only on weekdays, and have it do something with some user variables and only during daytime:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
--activate my scene
domoticz.scenes('Evening lights').switchOn()
if (domoticz.devices('My PIR').lastUpdate.minutesAgo > 5) then
domoticz.devices('Bathroom lights').switchOff()
end
end
end
}</syntaxhighlight>
Or you want to detect a humidity rise within the past 5 minutes:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'every 5 minutes'}
},
data =
{
previousHumidity = { initial = 100 }
},
execute = function(domoticz)
local bathroomSensor = domoticz.devices('BathroomSensor')
if (bathroomSensor.humidity - domoticz.data.previousHumidity) >= 5 then
-- there was a significant rise
domoticz.devices('Ventilator').switchOn()
end
-- store current value for next cycle
domoticz.data.previousHumidity = bathroomSensor.humidity
end
}</syntaxhighlight>
Just to give you an idea! Everything in your Domoticz system is now logically available in the domoticz object structure. With this domoticz object, you can get to all the information in your system and manipulate your devices.


= Using dzVents with Domoticz =

In Domoticz go to '''Setup > Settings > Other''' and in the section EventSystem make sure the check-box ‘dzVents disabled’ is not checked. Also make sure that in the Security section in the settings '''(Setup > Settings > System > Local Networks (no username/password)''' you allow 127.0.0.1 (and / or ::1 when using IPv6 ) to not need a password. dzVents does use this port to get the location settings and to send certain commands to Domoticz. Finally make sure you have set your current location in '''Setup > Settings > System > Location''', otherwise there is no way to determine nighttime/daytime state.

There are two ways of creating dzVents event scripts in Domoticz:

# By creating scripts in your domoticz instance on your domoticz server: <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Make sure that each script has the extension <code>.lua</code> and follows the guidelines as described below.
# By creating scripts inside Domoticz using the internal Domoticz event editor: Go to '''Setup > More Options > Events'''. Press the + button and choose dzVents. You must then choose a template. They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

'''Note: scripts that you write on the file-system and inside Domoticz using the internal web-editor all share the same name-space. That means that if you have two scripts with the same name, only the one of the file-system will be used. The log will tell you when this happens.'''

'''Note: Scripts created in the internal editor are stored in the domoticz database and are all written to <code>/path/to/domoticz/scripts/dzVents/generated_scripts</code> on every domoticz restart and every “EventSystem: reset all events…”. Scripts in <code>/path/to/domoticz/scripts/dzVents/scripts</code> are not stored in the database and should be backed-up separately. '''


== Quickstart ==

If you made sure that dzVents system is active, we can do a quick test if everything works:

* Pick a switch in your Domoticz system. Write down the exact name of the switch. If you don’t have a switch then you can create a Dummy switch and use that one.
* Create a new file in the <code>/path/to/domoticz/scripts/dzVents/scripts/</code> folder (or using the web-editor in Domoticz, switch to dzVents mode first.). Call the file <code>test.lua</code>. ''Note: when you create a script in the web-editor you do '''not''' add the .lua extension!'' Also, valid script names follow the same rules as [https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words filesystem names].
* Open <code>test.lua</code> in an editor and fill it with this code and change <code><exact name of the switch></code> with the .. you guessed it… exact name of the switch device:

<syntaxhighlight lang="lua"> return {
on = {
devices = {
'<exact name of the switch>'
}
},
execute = function(domoticz, switch)
if (switch.state == 'On') then
domoticz.log('Hey! I am on!')
else
domoticz.log('Hey! I am off!')
end
end
}</syntaxhighlight>
* Save the script
* Open the Domoticz log in the browser
* In Domoticz GUI perhaps in another browser tab) press the switch.
* You can watch the log in Domoticz and it should show you that indeed it triggered your script and you should see the log messages.

See the examples folder <code>/path/to/domoticz/scripts/dzVents/examples</code> for more examples. This folder includes templates you can use to get started as well. And, if you use the GUI web editor to write your script, you will find boilerplate examples in the drop-down below the script type setting.


= Writing scripts =

In order for your scripts to work with dzVents, they have to be turned into a Lua module with a specific structure. Basically you make sure it returns a Lua table (object) with predefined keys like <code>on</code> and <code>execute</code>. Here is an example:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'My switch' }
},

execute = function(domoticz, switch)
-- your script logic goes here, something like this:
if (switch.state == 'On') then
domoticz.log('I am on!', domoticz.LOG_INFO)
end
end
}</syntaxhighlight>
Simply said, the <code>on</code>-part defines the trigger and the <code>execute</code> part is what should be done if the trigger matches with the current Domoticz event. So all your logic is inside the <code>execute</code> function.


== Sections in the script ==

Each dzVents event script has this structure:

<syntaxhighlight lang="lua">return
{
active = true, -- optional
on =
{
-- at least one of these:
customEvents = { ... },
devices = { ... },
groups = { ... },
httpResponses = { ... },
scenes = { ... },
security = { ... },
shellCommandResponses = { ... },
system = { ... },
timer = { ... },
variables = { ... },

},
data = { ... }, -- optional
logging = { ... }, -- optional
execute = function(domoticz, item, triggerInfo)
-- your code here
end
}</syntaxhighlight>

=== active = true/false (optional) ===

If <code>active = false</code>, then the script is not activated: ''dzVents will ignore the script completely''. If you don’t have <code>active</code> specified, <code>true</code> is assumed (default value). If you write scripts with Domoticz’ internal script editor then you don’t need this part as the editor has its own way of enabling and disabling scripts.

So, <code>active</code> can either be:

* '''true''': (default) the script file will be processed.
* '''false''': the script file is ignored.
* '''function(domoticz) … end''': A function returning <code>true</code> or <code>false</code>. The function will receive the domoticz object with all the information about your domoticz instance: <code>active = function(domoticz) .... end</code>. For example you could check for a Domoticz variable or switch and prevent the script from being executed. '''However, be aware that for ''every script'' in your scripts folder, this active function will be called, every cycle!! Therefore, it is better to put all your logic in the execute function instead of in the active function.'''


=== on = { … } ===

The <code>on</code> section tells dzVents ''when'' the execute function has to be executed. It holds all the events/'''triggers''' that are monitored by dzVents. If any of the events or triggers match with the current event coming from Domoticz, then the <code>execute</code> part of the script is executed by dzVents. The <code>on</code> section has many kinds of subsections that ''can all be used simultaneously'' :


==== customEvents = { … } 3.0.0 ====

A list of one or more custom event triggers. This eventTrigger can be activate by a json/api call, a MQTT message (when domoticz is setup to listen to such messages on the hardware tab) or by the dzVents internal command domoticz.emitEvent - The name of the custom-event - The name of the custom-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|See time trigger rules]].


===== API =====

<pre>- curl: curl -d "{ 'a':10, 'b':20, 'some':'text', 'sub' : { 'x':10, 'y':20 } }" "http://<domoticzIP:domoticz port>/json.htm?type=command&param=customevent&event=<myCustomEvent>"
- JSON: **< domoticzIP : domoticz port >**/json.htm?type=command&param=customevent&event=<MyEvent>&data=myData
- MQTT simple: {"command":"customevent", "event":"MyEvent","data":"myData"}
- MQTT complex: {"command":"customevent","event":"MyEvent","data":"{\"idx\":29,\"test\":\"ok\"}" }
- emitEvent: domoticz.emitEvent('myCustomEvent' [,])
`domoticz.emitEvent('myEvent') -- no data`
`domoticz.emitEvent('another event', 'some data')`
`domoticz.emitEvent('hugeEvent', { a = 10, b = 20, some = 'text', sub = { x = 10, y = 20 } })`</pre>

===== Attributes =====

The customEvent object (second parameter in your execute function) has these attributes:

* '''data''': Raw customEvent data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''.3.0.3 true when the customEvent data is a valid json string. The data is then automatically converted to a Lua table.
* '''isXML''': ''Boolean''. 3.0.3 true when the customEvent data is a valid xml string. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. 3.0.3 When the customEvent data is a valid json string, the response data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a table for quick and easy access. nil otherwise
* '''trigger''', '''customEvent''': ''String''.3.0.3 The string that triggered this customEvent instance. This is useful if you have a script that can be triggered by multiple different customEvent strings.
* '''xml'''. ''Table''. 3.0.3 When the response data is a valid xml string, the customEvent data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


==== devices = { … } ====

A list of device-names or indexes. If a device in your system was updated (e.g. a switch was triggered or a new temperature was received) and it is listed in this section then the execute function is executed. '''Note''': update does not necessarily means the device state or value has changed. Each device can be:

* The name of your device between string quotes. '''You can use the asterisk (*) wild-card here e.g. <code>PIR_*</code> or <code>*_PIR</code>'''. E.g.: <code>devices = { 'myDevice', 'anotherDevice', 123, 'pir*' }</code>
* The index (idx) of your device (as the name may change, the index will usually stay the same, the index can be found in the devices section in Domoticz). '''Note that idx is a number;'''
* The name or idx of your device followed by a time constraint, such as: <code>['myDevice'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if <code>myDevice</code> was changed, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].


==== groups = { …} ====

A list of one or more group-names or indexes. The same rules as devices apply.


==== httpResponses = { …} ====

A list of one or more http callback triggers. Use this in conjunction with <code>domoticz.openURL()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


==== shellCommandResponses = { …} 3.1.0 ====

A list of one or more scriptcommand callback triggers. Use this in conjunction with <code>domoticz.executeShellCommand()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.


==== scenes = { … } ====

A list of one or more scene-names or indexes. The same rules as devices apply. So if your scene is listed in this table then the executed function will be triggered, e.g.: <code>on = { scenes = { 'myScene', 'anotherScene' } },</code>.


==== security = { … } ====

A list of one or more of these security states:

* <code>domoticz.SECURITY_ARMEDAWAY</code>,
* <code>domoticz.SECURITY_ARMEDHOME</code>,
* <code>domoticz.SECURITY_DISARMED</code>

If the security state in Domoticz changes and it matches with any of the states listed here, the script will be executed. See <code>/path/to/domoticz/scripts/dzVents/examples/templates/security.lua</code> for an example see [[#Security_Panel|Security Panel]] for information about how to create a security panel device.


==== system = { …} 3.0.0 ====

A list of one or more system triggers.

* <code>stop</code>, <code>start</code>, <code>manualBackupFinished</code>, <code>dailyBackupFinished</code>, <code>hourlyBackupFinished</code>, <code>monthlyBackupFinished</code>, <code>resetAllDeviceStatus</code>, 3.1.5 <code>resetAllEvents</code>, 3.1.5
* The name of the system-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].
** '''start''' - fired when Domoticz has started.
** '''stop''' - fired when Domoticz is shutting down. As you probably can imagine you have only a limited amount of time - also depending on the load on your system - to have Domoticz do stuff when your script has been completed. Some commands will probably not be executed. Just give it a try.
** '''Backups''' - the trigger item (2nd parameter of the execute function) is a table that holds information about the newly created backup (location, duration in seconds and type). You could use this information to copy the file to some other location or for another purpose.
*** '''dailyBackupFinished''' - automatic backup when set in domoticz
*** '''hourlyBackupFinished''' - ” ”
*** '''monthlyBackupFinished''' - ” ”
*** '''manualBackupFinished''' - fired when you start a backup using the Domoticz GUI or via '''< domoticz IP:domoticz port >'''/backupdatabase.php
*** '''resetAllDeviceStatus''' 3.1.5- fired when the name, description or used / unused state of a device, variable or scene is updated.
*** '''resetAllEvents''' 3.1.5- fired when a dzVents script in the internal editor changed.


==== timer = { … } ====

A list of one ore more time ‘rules’ like <code>every minute</code> or <code>at 17:*</code>. See [[#timer_trigger_rules|''timer'' trigger rules]]. If any or the rules matches with the current time/date then your execute function is called. E.g.: <code>on = { timer = { 'between 30 minutes before sunset and 30 minutes after sunrise' } }</code>.


==== variables = { … } ====

A list of one or more user variable-names as defined in Domoticz ( ''Setup > More options > User variables''). If any of the variables listed here is updated, ( '''Note''': update does not necessarily means the variable value or type changed ).the script is executed. '''Note''': Script will only execute when this variable is updated directly by dzVents or by a JSON. If updated with a standard Lua script (using commandArray) or in combination with a time option like afterAAA no event will be triggered.


=== execute = function('''domoticz, item, triggerInfo''') … end ===

When all the above conditions are met (active == true and the on section has at least one matching rule), then this <code>execute</code> function is called. This is the heart of your script. The function has three parameters:


==== 1. ('''domoticz''', item, triggerInfo) ====

The [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]]. This object gives you access to almost everything in your Domoticz system, including all methods to manipulate them—like modifying switches or sending notifications. More about the [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]] below.


==== 2. (domoticz, '''item''', triggerInfo) ====

Depending on what actually triggered the script, <code>item</code> is either a:

* [[#Custom_event_API|customEvent]] 3.0.0
* [[#Device_object_API|device]],
* [[#Variable_object_API_.28user_variables.29|variable]],
* [[#Scene|scene]],
* [[#Group|group]],
* [[#timer_=_%7B_..._%7D|timer]],
* [[#System_event_API|system]], 3.0.0
* [[#Security_Panel|security]] or
* [[#Asynchronous_HTTP_requests|httpResponse]]
* [[#Asynchronous_shell_command_executio|shellCommandResponse]] 3.1.0

Since you can define multiple on-triggers in your script, it is not always clear what the type is of this second parameter. In your code you need to know this in order to properly respond to the different events. To help you inspect the object you can use these attributes like <code>if (item.isDevice) then ... end</code>:

* '''isCustomEvent''': 3.0.0. returns <code>true</code> if the item is a customEvent object.
* '''isDevice''': . returns <code>true</code> if the item is a Device object.
* '''isGroup''': . returns <code>true</code> if the item is a Group object.
* '''isHTTPResponse''': . returns <code>true</code> if the item is an HTTPResponse object.
* '''isShellCommandResponse''': . 3.1.0 returns <code>true</code> if the item is a shellcommandResponse object.
* '''isScene''': . returns <code>true</code> if the item is a Scene object.
* '''isSecurity''': . returns <code>true</code> if the item is a Security object.
* '''isSystemEvent''': 3.0.0. returns <code>true</code> if the item is a system object.
* '''isTimer''': . returns <code>true</code> if the item is a Timer object.
* '''isVariable''': . returns <code>true</code> if the item is a Variable object.
* '''trigger''': . ''string''. the timer rule, the security state, the customEvent or the http response callback string that actually triggered your script. E.g. if you have multiple timer rules can inspect <code>trigger</code> which exact timer rule was fired.


==== 3. (domoticz, item, '''triggerInfo''') ====

'''Note''': as of version 2.4.0, <code>triggerInfo</code> has become more or less obsolete and is left in here for backward compatibility. All information is now available on the <code>item</code> parameter (second parameter of the execute function, see point 2 above).

<code>triggerInfo</code> holds information about what triggered the script. The object has two attributes:

# '''type''': the type of the the event that triggered the execute function, either: - domoticz.EVENT_TYPE_CUSTOM,3.0.0 - domoticz.EVENT_TYPE_DEVICE, - domoticz.EVENT_TYPE_GROUP - domoticz.EVENT_TYPE_HTTPRESPONSE - domoticz.EVENT_TYPE_SCENE, - domoticz.EVENT_TYPE_SECURITY, - domoticz.EVENT_TYPE_SYSTEM,3.0.0 - domoticz.EVENT_TYPE_TIMER, - domoticz.EVENT_TYPE_VARIABLE)
# '''trigger''': the timer rule that triggered the script if the script was called due to a timer event, or the security state that triggered the security trigger rule. See [[#timer_trigger_rules|below]] for the possible timer trigger rules.
# '''scriptName''': the name of the current script.


==== Tip: rename the parameters to better fit your needs ====

The names of the execute parameters are actually something you can change to your convenience. For instance, if you only have one trigger for a specific switch device, you can rename <code>item</code> it to <code>switch</code>. Or if you think <code>domoticz</code> is too long you can rename it to <code>d</code> or <code>dz</code> (might save you a lot of typing and may make your code more readable):

<syntaxhighlight lang="lua">return
{
on =
{
devices = 'mySwitch'
},
execute = function(dz, mySwitch)
dz.log(mySwitch.state, dz.LOG_INFO)
end
}</syntaxhighlight>

=== data = { … } (optional) ===

The optional data section allows you to define local variables that will hold their values ''between'' script runs. These variables can get a value in your execute function and the next time the script is executed these variables will have their previous state restored. For more information see the section [[#Persistent_data|Persistent data]].


=== logging = { … } (optional) ===

The optional logging section allows you to override the global logging setting of dzVents as set in ''Setup > Settings > Other > EventSystem > dzVents Log Level''. This can be handy when you only want this script to have extensive debug logging while the rest of your script executes silently. You have these options:

* '''level''': This is the minimum log level you want for this script. This can be domoticz.LOG_INFO, domoticz.LOG_STATUS, domoticz.LOG_ERROR or domoticz.LOG_DEBUG
* '''marker''': A string that is prefixed before each log message. That way you can easily create a filter in the Domoticz log to see just these messages. '''marker''' defaults to scriptname

\*LOG_DEBUG will also cause Execution Info to be displayed (start/finished)

Example:

<syntaxhighlight lang="lua">logging = {
level = domoticz.LOG_DEBUG,
marker = "Hey you"
},</syntaxhighlight>

== Some trigger examples ==


=== Custom events ===

Suppose you want to trigger a script not on the minute but 30 seconds later.

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every minute',
},

customEvents =
{
'delayed',
},
},
execute = function(domoticz, item)
if item.isTimer then
domoticz.emitEvent('delayed', domoticz.time.rawTime ).afterSec(30)
else
domoticz.notify('Delayed', 'Event was emitted at ' .. item.data, domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Device changes ===

Suppose you have two devices—a smoke detector ‘myDetector’ and a room temperature sensor ‘roomTemp’, and you want to send a notification when either the detector detects smoke or the temperature is too high:

<syntaxhighlight lang="lua">return
{
on =
{
devices = {
'myDetector',
'roomTemp'
}
},
execute = function(domoticz, device)
if ((device.name == 'myDetector' and device.active) or
(device.name == 'roomTemp' and device.temperature >= 45)) then
domoticz.notify('Fire', 'The room is on fire', domoticz.PRIORITY_EMERGENCY)
end
end
}</syntaxhighlight>

=== Scene / group changes ===

Suppose you have a scene ‘myScene’ and a group ‘myGroup’, and you want to turn on the group as soon as myScene is activated:

<syntaxhighlight lang="lua">return {
on = {
scenes = { 'myScene' }
},
execute = function(domoticz, scene)
if (scene.state == 'On') then
domoticz.groups('myGroup').switchOn()
end
end
}</syntaxhighlight>
Or, if you want to send an email when a group is activated at night:

<syntaxhighlight lang="lua">return {
on = {
groups = { ['myGroup'] = {'at nighttime'} }
},
execute = function(domoticz, group)
if (group.state == 'On') then
domoticz.email('Hey', 'The group is on', 'someone@the.world.org')
end
end
}</syntaxhighlight>

=== Timer events ===

Suppose you want to check the soil humidity every 30 minutes during the day and every hour during the night:

<syntaxhighlight lang="lua">return {
on = {
timer = {
'every 30 minutes at daytime',
'every 60 minutes at nighttime'
}
},
execute = function(domoticz, timer)
domoticz.log('The rule that triggered the event was: ' .. timer.trigger')
if (domoticz.devices('soil').moisture > 100) then
domoticz.devices('irrigation').switchOn().forMin(60)
end
end
}</syntaxhighlight>

=== Variable changes ===

Suppose you have a script that updates a variable ‘myAmountOfMoney’, and if that variable reaches a certain level you want to be notified:

<syntaxhighlight lang="lua">return
{
on =
{
variables = { 'myAmountOfMoney' }
},
execute = function(domoticz, variable)
-- variable is the variable that's triggered
if (variable.value > 1000000) then
domoticz.notify('Rich', 'You can stop working now', domoticz.PRIORITY_HIGH)
end
end
}</syntaxhighlight>

=== Security changes ===

Suppose you have a group holding all the lights in your house, and you want to switch it off as soon as the alarm is activated:

<syntaxhighlight lang="lua">return
{
on =
{
security = { domoticz.SECURITY_ARMEDAWAY }
},
execute = function(domoticz, security)
domoticz.groups('All lights').switchOff()
end
}</syntaxhighlight>

=== Asynchronous HTTP Request and handling ===

Suppose you have some external web service that will tell you what the current energy consumption is and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
httpResponses = { 'energyRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = 'http://url/to/service',
method = 'GET',
callback = 'energyRetrieved'
})
elseif (item.isHTTPResponse) then
if (item.ok) then -- statusCode == 2xx
local current = item.json.consumption
domoticz.devices('myCurrentUsage').updateEnergy(current)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


=== Asynchronous shell command execution 3.1.0 ===

Suppose you have some local shellcommand to measure the speed of your internet connection and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
shellCommandResponses = { 'internetspeedRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.executeShellCommand({
command = 'speedtest-cli --json', -- just an example
callback = 'internetspeedRetrieved', -- see shellCommandResponses above.
timeout = 20, -- max execution time in seconds
})
elseif (item.isShellCommandResponse) then
if (item.statusCode==0) then
domoticz.devices('myCurrentdownloadspeed').updateCustomSensor(item.json.download)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_shell_command_execution|asynchronous shell commands]] for more information.


=== System changes ===

Do some initial work when domoticz starts

<syntaxhighlight lang="lua">return
{
on =
{
system =
{
'start',
'backupDoneDaily',
},

},

execute = function(domoticz, system)
domoticz.log('Domoticz sends ' .. system.type, domoticz.LOG_INFO)

if system.type == 'start' then
domoticz.device('initial device').switchOff().silent
domoticz.variables('special startVar').set('domoticz started at ' .. domoticz.time.rawDateTime )
elseif system.type == 'backupDoneDaily' then
domoticz.notify('Domoticz backup', 'Ended. Backupfile ' .. system.data.location , domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Combined rules ===

Let’s say you have a script that checks the status of a lamp and is triggered by motion detector:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
devices = { 'myDetector' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- the timer was triggered
domoticz.devices('myLamp').switchOff()
elseif (item.isDevice and item.active) then
-- it must be the detector
domoticz.devices('myLamp').switchOn()
end
end
}</syntaxhighlight>

=== At startup trigger ===

You can add <code>at_startup = true</code> to the <code>on</code> section to have your script execute once when Domoticz starts, in addition to any other triggers. This is useful when combined with interval-based rules to avoid waiting for the first interval to pass:

<syntaxhighlight lang="lua">return {
on = {
at_startup = true,
timer = { 'every hour' },
},
execute = function(domoticz, item)
-- Runs immediately when Domoticz starts, then every hour
domoticz.devices('myThermostat').setPoint(21)
end
}</syntaxhighlight>
The <code>at_startup</code> trigger fires on the first timer tick after Domoticz starts (within 2 minutes of startup). It can be combined with any other trigger types (timer, devices, httpResponses, etc.).

'''Note:''' This is different from <code>system = { 'start' }</code> which is a system event trigger. <code>at_startup</code> is simpler - just add the flag and your existing script will also run at startup without needing to check <code>item.isSystemEvent</code>.


== ''timer'' trigger rules ==

There are several options for time triggers. It is important to know that Domoticz timer events only trigger once every minute, so one minute is the smallest interval for your timer scripts. However, dzVents gives you many options to have full control over when and how often your timer scripts are called (all times are in 24hr format and all dates in dd/mm): Keywords recognized are “at, between, every, except, in, on, or” ( except supported from version 3.0.16, or supported from version 3.1.8 ).

At every place you read <astroMoment> you can use one of: sunset, sunrise, solarnoon, midnight '', sunatsouth '', civiltwilightstart, civiltwilightend, astronomicaltwilightstart '', astronomicaltwilightend '', nauticaltwilightstart * or nauticaltwilightend *.

Full daynames are allowed in dzVents >= 3.1.7

* 3.1.16

<syntaxhighlight lang="lua"> on = {
timer = {
'every minute', -- causes the script to be called every minute
'every other minute', -- minutes: xx:00, xx:02, xx:04, ..., xx:58
'every <xx> minutes', -- starting from xx:00 triggers every xx minutes
-- (0 > xx < 60)
'every hour', -- 00:00, 01:00, ..., 23:00 (24x per 24hrs)
'every other hour', -- 00:00, 02:00, ..., 22:00 (12x per 24hrs)
'every <xx> hours', -- starting from 00:00, triggers every xx
-- hours (0 > xx < 24)
'at 13:45', -- specific time
'at *:45', -- every 45th minute in the hour
'at 15:*', -- every minute between 15:00 and 16:00
'at 12:45-21:15', -- between 12:45 and 21:15. You cannot use '*'!
'at 19:30-08:20', -- between 19:30 and 8:20 (next day)
'at 13:45 on mon,tue', -- at 13:45 only on Mondays and Tuesdays (english)
'on mon,tue', -- on Mondays and Tuesdays
'every hour on Saturday', -- you guessed it correctly
'at sunset', -- uses sunset/sunrise/solarnoon info from Domoticz
'at sunrise',
'at <astroMoment>', -- dzVents >= 3.0.16 Uses the times received from Domoticz
'at <astroMoment> on sat,sun',
'xx minutes before <astroMoment>', --
'xx minutes after <astroMoment>', -- Please note that these relative times will cross dates
'between aa and bb' -- aa/bb can be a time stamp like 15:44 (if aa > bb will cross dates)
-- aa/bb can be sunrise/sunset/solarnoon ('between sunset and sunrise' and 'between solarnoon and sunrise' will cross dates)
-- aa/bb can be 'xx minutes before/after <astroMoment>'
'at <astroRange>', -- between <astroMoment>start and <astroMoment>end
'at nighttime', -- between sunset and sunrise
'at daytime', -- between sunrise and sunset
'at daytime on mon,tue', -- between sunrise and sunset only on Mondays and Tuesdays
'in week 1-7,44' -- in week 1-7 or 44
'in week 20-25,33-47' -- between week 20 and 25 or week 33 and 47
'in week -12, 33-' -- week <= 12 or week >= 33
'every odd week',
'every even week', -- odd or even numbered weeks
'on 23/11', -- on 23rd of November (dd/mm)
'on 23/11-25/12', -- between 23/11 and 25/12
'on 2/3-8/3,7/8,6/10-14/10',-- between march 2 and 8, on august 7 and between October 6 and 14.
'on */2,15/*', -- every day in February or
-- every 15th day of the month
'on -3/4,4/7-', -- before 3/4 or after 4/7

'at 12:45-21:15 except at 18:00-18:30', -- between 12:45 and 21:15 but not between 18:00 and 18:30 ( except supported from 3.0.16 onwards )
'at daytime except on sun', -- between sunrise and sunset but not on Sundays
'at daytime or at 23:12', -- between sunrise and sunset and also at 23:12

-- or if you want to go really wild and combine them:
'at nighttime at 21:32-05:44 every 5 minutes on sat, sun except at 04:00', -- except supported from 3.0.16 onwards
'every 10 minutes between 20 minutes before sunset and 30 minutes after sunrise on mon,fri,tue on 20/5-18/8'

-- or just do it yourself:
function(domoticz)
-- you can use domoticz.time to get the current time
-- note that this function is called every minute!
-- custom code that either returns true or false
...
end
},
}</syntaxhighlight>
The timer events are triggered every minute. If such a trigger occurs, dzVents will scan all timer-based events and will evaluate the timer rules. So, if you have a rule <code>on mon</code> then the script will be executed ''every minute'' but only on Monday.

Be mindful of the logic if using multiple types of timer triggers. It may not make sense to combine a trigger for a specific or instantaneous time with a trigger for a span or sequence of times (like ‘at sunset’ with ‘every 6 minutes’) in the same construct. Similarly, <code>'between aa and bb'</code> only makes sense with instantaneous times for <code>aa</code> and <code>bb</code>.

'''One important note: if Domoticz, for whatever reason, skips a timer event then you may miss the trigger! Therefore, you should build in some fail-safe checks or some redundancy if you have critical time-based stuff to control. There is nothing dzVents can do about it'''

'''Tip:''' If you want your timer script to also run at Domoticz startup (instead of waiting for the first timer match), add <code>at_startup = true</code> to your <code>on</code> section. See [[#at-startup-trigger|At startup trigger]].

Another important issue: the way it is implemented right now, the <code>every xx minutes</code> and <code>every xx hours</code> is a bit limited. The interval resets at every *:00 (for minutes) or 00:* for hours. You need an interval that is an integer divider of 60 (or 24 for the hours). So you can do every 1, 2, 3, 4, 5, 6, 10, 12, 15, 20 and 30 minutes only.


= The domoticz object =

The domoticz object passed as the first parameter to the <code>execute</code> function contains everything you need to interact with your domotica system. It provides all information made available by the domoticz event system about your custom- and system events, devices, scenes, groups, hardware modules and variables and has methods needed to inspect and manipulate them. Getting this information is easy:

<code>domoticz.time.isDayTime</code> or <code>domoticz.devices('My sensor').temperature</code> or <code>domoticz.devices('My sensor').lastUpdate.minutesAgo</code>.

The domoticz object consists of a logically arranges structure. It harbors all methods to manipulate Domoticz. dzVents will take care to notify Domoticz with all your intended changes and actions. Earlier you had to fill a commandArray with obscure commands. That’s no longer the case.

Some more examples: <code>domoticz.devices(123).switchOn().forMin(5).afterSec(10)</code> or <code>domoticz.devices('My dummy sensor').updateBarometer(1034, domoticz.BARO_THUNDERSTORM)</code>.

One tip before you get started: '''Make sure that all your devices have unique names. dzVents will give you warnings in the logs if device names are not unique.'''


== Domoticz object API (Application Programming Interface) ==

The domoticz object holds all information about your Domoticz system. It has global attributes and methods to query and manipulate your system. It also has a collection of '''devices''', '''variables''' (user variables in Domoticz), '''scenes''', '''groups''', '''hardware'''. Each of these collections has four iterator functions: <code>find(), forEach()</code>, <code>filter()</code> and <code>reduce()</code> to make searching for devices easier. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]].


=== Domoticz attributes and methods ===

* '''devices(idx/name)''': ''Function''. A function returning a device by idx or name: <code>domoticz.devices(123)</code> or <code>domoticz.devices('My switch')</code>. For the device API see [[#Device_object_API|Device object API]]. To iterate over all devices do: <code>domoticz.devices().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.devices()) do .. end</code>.
* '''dump([osfile]3.0.0)''': ''Function''. Dump all domoticz.settings attributes to the Domoticz log. This ignores the log level setting.
* '''email(subject, message, mailTo [, delay]3.0.10)''': ''Function''. Send email. Optional parm delay is delay in seconds.
* '''emitEvent(name,[extra data ])''':''Function''. 3.0.0 Have Domoticz ‘call’ a customEvent. If you just pass a name then Domoticz will execute the script(s) that subscribed to the named customEvent after your script has finished. You can optionally pass extra information as a string or table. A table will be automatically converted into a json string and converted back to a table in the subscribed script(s). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''executeShellCommand(command/options)''': ''Function''. 3.1.0 Have Domoticz ‘call’ a command. If you just pass a command then Domoticz will execute the command after your script has finished but you will not get notified. If you pass options table with a callback then you have the possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_shell_command_execution|asynchronous shell commands]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. '''Note Make sure that when you use this function on a Windows system and use one or more of the special chars &<>()@^| outside double quotes, you will have to escape these with a ^ char '''
* '''groups(idx/name)''': ''Function'': A function returning a group by name or idx. Each group has the same interface as a device. To iterate over all groups do: <code>domoticz.groups().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.groups()) do .. end</code>. Read more about [[#Group|Groups]].
* '''hardwareInfo(idx/name)''': 3.0.6 ''Function'': A function returning hardwareInfo of a hardware module by name or idx. The return of the function is a table with attributes name, type, typeValue, deviceNames (table with names of all active devices defined on this hardware) and deviceIds (table with idx of all active devices defined on this hardware)
* '''hardware(idx/name)''': 3.0.7 ''Function'': A function returning a hardware module by name or idx. Each hardware has an interface comparable to group. To iterate over all hardware do: <code>domoticz.hardware().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.hardware()) do .. end</code>. Read more about [[#Hardware|Hardware]].
* '''helpers''': ''Table''. Collection of shared helper functions available to all your dzVents scripts. See [[#Shared_helper_functions|Shared helper functions]].
* '''log(message, [level])''': ''Function''. Creates a log entry in the Domoticz log but respects the log minimum level settings. You can provide the loglevel: <code>domoticz.LOG_INFO</code>, <code>domoticz.LOG_STATUS</code>, <code>domoticz.LOG_ERROR</code>, <code>domoticz.LOG_DEBUG</code> or <code>domoticz.LOG_FORCE</code>. In Domoticz settings you can set the default log level for dzVents.
* '''moduleLabel''': 3.0.3 Module (script) name without extension.
* '''notify(subject, message [,priority][,sound][,extra][,subsystem][,delay]3.0.10 )''': ''Function''. Send a notification (like Prowl). Priority can be like <code>domoticz.PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY</code>. <code>extra</code> is notification subsystem specific. For NSS_FIREBASE you can use this field to specify the target mobile (‘midx_1’, midx_2, etc..) or specify <code>device.id</code> so the receiver knows which device triggered the notification. For sound see [[#Constants|list of dzVents Constants]] for the SOUND constants below. <code>subsystem</code> defaults to all subsystems but can be one subsystem or a table containing one or more notification subsystems. See [[#Constants|list of dzVents Constants]] for <code>domoticz.NSS_subsystem</code> types. Delay is delay in seconds
* '''openURL(url/options)''': ''Function''. Have Domoticz ‘call’ a URL. If you just pass a url then Domoticz will execute the url after your script has finished but you will not get notified. If you pass a table with options then you have to possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_HTTP_requests|asynchronous http requests]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''scenes(idx/name)''': ''Function'': A function returning a scene by name or id. Each scene has the same interface as a device. See [[#Device_object_API|Device object API]]. To iterate over all scenes do: <code>domoticz.scenes().forEach(..)</code>. See [[#looping-through-the-collections-iterators|Looping through the collections: iterators]]. (#Looping_through_the_collections:_iterators). Note that you cannot do <code>for i, j in pairs(domoticz.scenes()) do .. end</code>. Read more about [[#Scene|Scenes]].
* '''security''': Holds the state of the security system e.g. <code>Armed Home</code> or <code>Armed Away</code>.
* '''sendCommand(command, value[, delay] 3.0.10)''': Generic (low-level)command method (adds it to the commandArray) to the list of commands that are being sent back to domoticz. Optional parm delay is delay in seconds ''There is likely no need to use this directly. Use any of the device methods instead (see below).''
* '''settings''':
** '''domoticzVersion''': domoticz version string.
** '''dzVentsVersion''': dzVents version string.
** '''location'''
*** '''latitude''': domoticz settings locations latitude.
*** '''longitude''': domoticz settings locations longitude.
*** '''name''': domoticz settings location Name.
** '''secureServer''': ''boolean'' 3.1.1 true when domoticz can be accessed via https.
** '''serverPort''': webserver listening port used by dzVents to access domoticz API.
** '''url''': internal url to access the API service.
** '''webRoot''': <code>webroot</code> 3.1.1 value as specified when starting the Domoticz service (or default).
** '''wwwBind''': <code>wwwbind</code> 3.1.4 value as specified when starting the Domoticz service (or default).
* '''sms(message [, delay] 3.0.10 )''': ''Function''. Sends an sms if it is configured in Domoticz. Optional parm delay is delay in seconds.
* '''snapshot(cameraID(s) or camera Name(s)3.0.13,subject)''': ''Function''. Sends email with a camera snapshots if email is configured and set for attachments in Domoticz. Send 1 or multiple camerIDs -names in ; separated string or array.

<syntaxhighlight lang="lua"> dz.snapshot() -- defaults to id = 1, subject domoticz
dz.snapshot(1,'dz') -- subject dz
dz.snapshot('1;2;3') -- ; separated string
dz.snapshot({1,4,7}) -- table
dz.snapshot('test;test2') -- ; separated string
dz.snapshot({'test', 'test2'}) -- table</syntaxhighlight>
<ul>
<li>'''switchTimerPlan(idx)''': ''Function''. Switch the active timer plan to the plan with the given database ID. <code>idx</code> must be a positive integer matching an existing timer plan ID (as shown in '''Settings → Timer Plans'''). Invalid or non-existent plan IDs are silently ignored. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''startTime''': ''[[#Time_object|Time Object]]''. Returns the startup time of the Domoticz service.</li>
<li>'''systemUptime''': ''Number''. Number of seconds the system is up.</li>
<li>'''time''': ''[[#Time_object|Time Object]]'': Current system time. Additional to Time object attributes:
<ul>
<li>'''isDayTime''': ''Boolean''</li>
<li>'''isNightTime''': ''Boolean''</li>
<li>'''isCivilDayTime''': ''Boolean''.</li>
<li>'''isCivilNightTime''': ''Boolean''.</li>
<li>'''isToday''': ''Boolean''. Indicates if the device was updated today</li>
<li>'''sunriseInMinutes''': ''Number''. Number of minutes since midnight when the sun will rise.</li>
<li>'''sunsetInMinutes''': ''Number''. Number of minutes since midnight when the sun will set.</li>
<li>'''civTwilightStartInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will start.</li>
<li>'''civTwilightEndInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will end.</li></ul></li>
<li>'''triggerHTTPResponse([httpResponse], [delay], [message])''': ''Function''. Creates a callback by sending a logmessage. httpResponse defaults to scriptname, delay defaults to 0 (immediate), message defaults to httpResponse. Left in for backward compatibility only. You can use emitEvent / customEvents now.</li>
<li>'''triggerIFTTT(makerName [,sValue1, sValue2, sValue3])''': ''Function''. Have Domoticz ‘call’ an IFTTT maker event. makerName is required, 0-3 sValue’s are optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''utils''': . A subset of handy utilities: Note that these functions must be preceded by domoticz.utils. If you use more then a few declare something like local _u = domoticz.utils at the beginning of your script and use _u.functionName in the remainder. Example:
<syntaxhighlight lang="lua"> _u = domoticz.utils
print(_u.rightPad('test',10) .. '|||') -- => test |||</syntaxhighlight>
<ul>
<li>'''_.lodashFunctions''': This is an entire collection with very handy Luafunctions. Read more about [[#lodash_for_Lua|lodash]]. E.g.: <code>{.lua} domoticz.utils._.size({'abc', 'def'}))` Returns 2.</code></li>
<li>'''cameraExists(parm)''': ''Function'': returns name when entered with a valid camera 3.0.12 or cameraID and return ID when entered with valid cameraName or false when not a camera, cameraID or cameraName of an existing camera</li>
<li>'''deviceExists(parm)''': ''Function'': returns name when entered with a valid device 3.0.12 or deviceID and returns ID when entered with valid deviceName or false when not a device, deviceID or deviceName of an existing (and active) device. Example:
<syntaxhighlight lang="lua">local dz = domoticz
local _u = dz.utils
if _u.deviceExists('myDevice') then
dz.devices('myDevice').switchOn()
else
dz.log('Device myDevice does not exist!', dz.LOG_ERROR)
end

local myName = _u.deviceExists(123)
if myName then
dz.log('Device 123 is ' .. myName, dz.LOG_INFO)
else
dz.log('Device 123 does not exist', dz.LOG_ERROR)
end</syntaxhighlight></li>
<li>'''dumpTable(table,[levelIndicator],[osfile]3.0.0))''': ''Function'': print table structure and contents to log</li>
<li>'''fileExists(path)''': ''Function'': Returns <code>true</code> if the file (with full path) exists.</li>
<li>'''fromBase64(string)''': ''Function'': Decode a base64 string</li>
<li>'''fromJSON(json, fallback, deSerialize 3.1.8 )''': ''Function''. Turns a json string to a Lua table. Example: <code>local t = domoticz.utils.fromJSON('{ "a": 1 }')</code>. Followed by: <code>print( t.a )</code> will print 1. Optional 2nd param fallback will be returned if json is nil or invalid. Optional 3rd param deSerialize (boolean) determines if the JSON should be deserialized before converting.</li>
<li>'''fromXML(xml, fallback )''': ''Function'': Turns a xml string to a Lua table. Example: <code>local t = domoticz.utils.fromXML('<testtag>What a nice feature!</testtag>') Followed by:</code>print( t.texttag)` will print What a nice feature! Optional 2nd param fallback will be returned if xml is nil or invalid.</li>
<li>'''fuzzyLookup([string|array of strings], parm)''': ''Function'': 3.0.14. Search fuzzy matching string in parm. If parm is string it returns a number (lower is better match). If parm is array of strings it returns the best matching string.</li>
<li>'''groupExists(parm)''': ''Function'': returns name when entered with a valid group 3.0.12 or groupID and return ID when entered with valid groupName or false when not a group, groupID or groupName of an existing group</li>
<li>'''hardwareExists(parm)''': ''Function'': 3.0.7 returns name when entered with valid hardwareID or ID when entered with valid hardwareName or false when not a hardwareID or hardwareName of an existing (and active )hardware module</li>
<li>'''inTable(table, searchString)''': ''Function'': Returns <code>"key"</code> if table has searchString as a key, <code>"value"</code> if table has searchString as value and <code>false</code> otherwise.</li>
<li>'''isJSON(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘application/json’ or string is enclosed in {} and <code>false</code> otherwise.</li>
<li>'''isXML(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘text/xml’ or ‘application/xml’ or string is enclosed in <> and <code>false</code> otherwise.</li>
<li>'''leftPad(string, length [, character])''': ''Function'': Precede string with given character(s) (default = space) to given length.</li>
<li>'''centerPad(string, length [, character])''': ''Function'': Center string by preceding and succeeding with given character(s) (default = space) to given length.</li>
<li>'''numDecimals(number [, integer [, decimals ]])''': ''Function'': Format number to float representation. ''Examples:''</li></ul>

<syntaxhighlight lang="lua"> domoticz.utils.numDecimals(12.23, 4, 4) -- => 12.2300,
domoticz.utils.numDecimals (12.23,1,1) -- => 12.2,
domoticz.utils.leadingZeros(domoticz.utils.numDecimals (12.23,4,4),9) -- => 0012.2300</syntaxhighlight>
<ul>
<li>'''osCommand(cmd)''': ''Function'': 3.0.13 Execute an OS command and return result and returncode. Note: For long running scripts <code>domoticz.executeShellCommand()</code> should be used, See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''osExecute(cmd)''': ''Function'': Execute an OS command (no return). Note: For long running scripts <code>executeShellCommand()</code> should be used. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''rightPad(string, length [, character])''': ''Function'': Succeed string with given character(s) (default = space) to given length.</li>
<li>'''round(number, [decimalPlaces])''': ''Function''. Helper function to round numbers. Default decimalPlaces is 0.</li>
<li>'''sceneExists(parm)''': ''Function'': returns name when entered with valid scene 3.0.12 or sceneID and return ID when entered with valid sceneName or false when not a scene, sceneID or sceneName of an existing scene</li>
<li>'''setLogMarker([marker])''': ''Function'': set logMarker to ‘marker’. Defaults to scriptname. Can be used to change logMarker based on flow in script</li>
<li>'''splitLine(string , splitOnWord ) 3.1.8)''':''Function''. Helper function to split a line. Return is a table with line-segments.</li>
<li>'''stringSplit(string [,separator ] [,convertNumber ][,convertNil ]3.0.17)''':''Function''. Helper function to split a line in separate words. Default separator is space. Return is a table with separated words. Default convertNumber is false when set to true it will convert strings to number where possible. Word is ignored when nil, unless convertNil is set; in that case word will be set to the convertNil value.</li>
<li>'''stringToSeconds(str)''': ''Function'': 3.0.1 Returns number of seconds between now and str. ''Examples:''
<syntaxhighlight lang="lua">domoticz.utils.stringToSeconds('09:00') -- number of seconds between now and 09:00 hr.
domoticz.utils.stringToSeconds('08:53:30 on fri') -- number of seconds between now and Friday at 08:53:30
domoticz.utils.stringToSeconds('08:53:30 on sat, sun') -- number of seconds between now and Saturday or Sunday at 08:53:30 ;whatever comes first</syntaxhighlight></li>
<li>'''toBase64(string)''': ''Function'': ) Encode a string to base64</li>
<li>'''toCelsius(f, relative)''': ''Function''. Converts temperature from Fahrenheit to Celsius along the temperature scale or when relative == true it uses the fact that 1F = 0.56C. So <code>toCelsius(5, true)</code> returns 5F*(1/1.8) = 2.78C.</li>
<li>'''toJSON(luaTable)''': ''Function''. Converts a Lua table to a json string.</li>
<li>'''toXML(luaTable, [header])''': ''Function''. Converts a Lua table to a xml string.</li>
<li>'''urlDecode(s)''': ''Function''. Simple deCoder to convert a string with escaped chars (%20, %3A and the likes) to human readable format.</li>
<li>'''urlEncode(s, [strSub])''': ''Function''. Simple url encoder for string so you can use them in <code>openURL()</code>. <code>strSub</code> is optional and defaults to + but you can also pass %20 if you like/need.</li>
<li>'''variableExists(parm)''': ''Function'': returns name when entered with a valid variable 3.0.12 or variableID and return ID when entered with valid variableName or false when not a variable, variableID or variableName of an existing variable</li>
<li>'''leadingZeros(number, length)''': ''Function'': Precede number with given zeros to given length.</li>
<li>'''variables(idx/name)''': ''Function''. A function returning a variable by it’s name or idx. See [Variable object API] (#Variable_object_API_.28user_variables.29) for the attributes. To iterate over all variables do: <code>domoticz.variables().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. '''Note that you cannot do <code>for i, j in pairs(domoticz.variables()) do .. end</code>'''.</li></ul></li></ul>


=== Looping through the collections: iterators ===

The domoticz object has these collections (tables): devices, scenes, groups, variables, changedDevices and changedVariables. You cannot use the <code>pairs()</code> or <code>ipairs()</code> functions. Therefore dzVents has four iterator methods:

# '''find(function)''': Returns the item in the collection for which <code>function</code> returns true. When no item is found <code>find</code> returns nil.
# '''forEach(function)''': Executes function once per array element. The function receives the item in the collection (device or variable). If the function returns ''false'', the loop is aborted.
# '''filter(function / table)''': returns items in the collection for which the function returns true. You can also provide a table with names and/or ids.
# '''reduce(function, initial)''': Loop over all items in the collection and do some calculation with it. You call it with the function and the initial value. Each iteration the function is called with the accumulator and the item in the collection. The function does something with the accumulator and returns a new value for it.


==== Examples: ====

find():

<syntaxhighlight lang="lua"> local myDevice = domoticz.devices().find(function(device)
return device.name == 'myDevice'
end)
domoticz.log('Id: ' .. myDevice.id)</syntaxhighlight>
forEach():

<syntaxhighlight lang="lua"> domoticz.devices().forEach(function(device)
if (device.batteryLevel < 20) then
-- do something
end
end)</syntaxhighlight>
filter():

<syntaxhighlight lang="lua"> local deadDevices = domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end)
deadDevices.forEach(function(zombie)
-- do something
end)</syntaxhighlight>
or

<syntaxhighlight lang="lua"> local livingLights = {
'window',
'couch',
33, -- kitchen light id
}
local lights = domoticz.devices().filter(livingLights)
lights.forEach(function(light)
-- do something
light.switchOn()
end)</syntaxhighlight>
Of course you can chain:

<syntaxhighlight lang="lua"> domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end).forEach(function(zombie)
-- do something with the zombie
end)</syntaxhighlight>
Using a reducer to count all devices that are switched on:

<syntaxhighlight lang="lua"> local count = domoticz.devices().reduce(function(acc, device)
if (device.state == 'On') then
acc = acc + 1 -- increase the accumulator
end
return acc -- always return the accumulator
end, 0) -- 0 is the initial value for the accumulator</syntaxhighlight>

=== Constants ===

The domoticz object has these constants available for use in your code e.g. <code>domoticz.LOG_INFO</code>.

'''IMPORTANT: you have to prefix these constants with the name of your domoticz object. Example: <code>domoticz.ALERTLEVEL_RED</code>''':

* '''ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_ORANGE, ALERTLEVEL_RED, ALERTLEVEL_YELLOW''': for updating text sensors.
* '''BASETYPE_CUSTOM_EVENT 3.0.0,BASETYPE_DEVICE, BASETYPE_SCENE, BASETYPE_GROUP, BASETYPE_HARDWARE''' 3.0.7, '''BASETYPE_VARIABLE, BASETYPE_SECURITY, BASETYPE_TIMER, BASETYPE_HTTP_RESPONSE, BASETYPE_SYSTEM'''3.0.0: indicators for the various object types that are passed as the second parameter to the execute function. E.g. you can check if an object is a device object: <code>Lua if (item.baseType == domoticz.BASETYPE_DEVICE) then ... end</code>
* '''BARO_CLOUDY, BARO_CLOUDY_RAIN, BARO_STABLE, BARO_SUNNY, BARO_THUNDERSTORM, BARO_NOINFO, BARO_UNSTABLE, BARO_COMPUTE''' : for updating barometric values.
* '''EVENT_TYPE_DEVICE, EVENT_TYPE_VARIABLE, EVENT_TYPE_CUSTOM''', 3.0.0 '''EVENT_TYPE_SECURITY, EVENT_TYPE_HTTPRESPONSE, EVENT_TYPE_SYSTEM,''' 3.0.0 '''EVENT_TYPE_TIMER''': triggerInfo types passed to the execute function in your scripts.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_TEMPORARY_OVERRIDE, EVOHOME_MODE_PERMANENT_OVERRIDE, EVOHOME_MODE_FOLLOW_SCHEDULE''': mode for EvoHome system.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_AUTOWITHRESET, EVOHOME_MODE_AUTOWITHECO, EVOHOME_MODE_AWAY, EVOHOME_MODE_DAYOFF, EVOHOME_MODE_CUSTOM, EVOHOME_MODE_HEATINGOFF''' : mode for EvoHome controller
* '''HUM_COMFORTABLE, HUM_DRY, HUM_NORMAL, HUM_WET, HUM_COMPUTE''' 3.0.15: constant for humidity status.
* '''INTEGER, FLOAT, STRING, DATE, TIME''': variable types.
* \**LOG_INFO, LOG_STATUS, LOG_ERROR, LOG_DEBUG, LOG_FORCE: for logging messages. LOG_FORCE will always be displayed.
* '''NSS_CLICKATELL''' 3.1.3, '''NSS_FIREBASE, NSS_FIREBASE_CLOUD_MESSAGING, NSS_GOOGLE_DEVICES,''' 3.0.10 Only with installed casting plugin, '''NSS_HTTP, NSS_KODI, NSS_LOGITECH_MEDIASERVER, NSS_NMA,NSS_PROWL, NSS_PUSHALOT, NSS_PUSHBULLET, NSS_PUSHOVER, NSS_PUSHSAFER, NSS_TELEGRAM, NSS_GOOGLE_CLOUD_MESSAGING''' deprecated by Google and replaced by firebase: for notification subsystem
* '''PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY''': for notification priority.
* '''SECURITY_ARMEDAWAY, SECURITY_ARMEDHOME, SECURITY_DISARMED''': for security state.
* '''STATE_IDLE, STATE_COOLING, STATE_HEATING''': for thermostat operating state.
* '''SOUND_ALIEN , SOUND_BIKE, SOUND_BUGLE, SOUND_CASH_REGISTER, SOUND_CLASSICAL, SOUND_CLIMB , SOUND_COSMIC, SOUND_DEFAULT, SOUND_ECHO, SOUND_FALLING, SOUND_GAMELAN, SOUND_INCOMING, SOUND_INTERMISSION, SOUND_MAGIC, SOUND_MECHANICAL, SOUND_NONE, SOUND_PERSISTENT, SOUND_PIANOBAR , SOUND_SIREN, SOUND_SPACEALARM, SOUND_TUGBOAT, SOUND_UPDOWN''': for notification sounds.


== Custom event API ==

If you have a dzVents script that is triggered by a customEvent in Domoticz then the second parameter passed to the execute function will be a ''notification'' object. The object.type = customEvent (isCustomEvent: true) and object.data contains the passed data to this script. object.trigger is the name of the customEvent that triggered the script.


== Device object API ==

If you have a dzVents script that is triggered by switching a device in Domoticz then the second parameter passed to the execute function will be a ''device'' object. Also, each device in Domoticz can be found in the <code>domoticz.devices()</code> collection (see above). The device object has a set of fixed attributes like ''name'' and ''idx''. Many devices, however, have different attributes and methods depending on their (hardware)type, subtype and other device specific identifiers. It is possible that you will get an error if you call a method on a device that doesn’t support it, so please check the device properties for your specific hardware to see which are supported (can also be done in your script code!).

dzVents recognizes most of the different device types in Domoticz and creates the proper attributes and methods. It is possible that your device type has attributes that are not recognized; if that’s the case, please create a ticket in the Domoticz [https://github.com/domoticz/domoticz/issues issue tracker on GitHub], and an adapter for that device will be added.

If for some reason you miss a specific attribute or data for a device, then likely the <code>rawData</code> attribute will have that information.


== Device attributes and methods for all devices ==

<ul>
<li>'''active''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Same as bState.</li>
<li>'''baseType''' ''String''. ‘camera’, ‘device’, ‘group’, ‘scene’, ‘hardware’, ‘uservariable’ or ‘security’</li>
<li>'''batteryLevel''': ''Number'' If applicable for that device then it will be from 0-100.</li>
<li>'''bState''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Better to use active.</li>
<li>'''changed''': ''Boolean''. True if the device was updated. '''Note''': This does not necessarily means the device state or value changed.</li>
<li>'''customImage''': ''Number''. When customImage is used for the device-icon this will be the icon-number. It will be 0 if the icon was not changed.</li>
<li>'''description''': ''String''. Description of the device.</li>
<li>'''deviceId''': ''String''. Another identifier of devices in Domoticz. dzVents uses the id(x) attribute. See device list in Domoticz’ settings table.</li>
<li>'''deviceSubType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''deviceType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''dump()''': ''Function''. Dump all attributes except functions and complete time overview to the Domoticz log. This ignores the log level setting. Use fullDump to include everything.</li>
<li>'''dumpSelection([{‘attributes’} ‘functions’ ‘tables’])''': ''Function''. 3.0.5 Dump attributes, function-names or table-names to the Domoticz log. This ignores the log level setting.</li>
<li>'''fullDump()''' ''Function''. 3.1.16 Dump all attributes including functions and the complete time overview to the Domoticz log. This ignores the log level setting. Most of the time dump() shows everything what is needed to debug.</li>
<li>'''hardwareName''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareId''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''icon''': ''String''. Name of the icon in Domoticz GUI.</li>
<li>'''id''': ''Number''. Index of the device. You can find the index in the device list (idx column) in Domoticz settings. It’s not truly an index but is unique enough for dzVents to be treated as an id.</li>
<li>'''idx''': ''Number''. Same as id: index of the device</li>
<li>'''inActive''': ''Boolean''. 3.1.0 true if active is false and vice versa. If active is nil inActive is also nil</li>
<li>'''lastUpdate''': ''[[#Time_object|Time Object]]'': Time when the device was updated. **Note: The lastUpdate for devices that triggered the script at hand is in fact the previousUpdate time. The real lastUpdate time for these “script triggering” devices is the current time.</li>
<li>'''name''': ''String''. Name of the device.</li>
<li>'''nValue''': ''Number''. Numerical representation of the state.</li>
<li>'''protected''': ''Boolean''. True when device / scene / group is protected. False otherwise.</li>
<li>'''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]</li>
<li>'''protectionOn()''': ''Function''. switch protection to on. Supports some [command options] !! **Note: domoticz protects against GUI and API access only. switchOn / switchOff type Blockly / Lua / dzVents commands are not influenced (because they are executed as admin user)</li>
<li>'''rawData''': ''Table'': All values are ''String'' types and hold the raw data received from Domoticz.</li>
<li>'''rename(newName)''': ''Function''. Change current devicename to new devicename Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setDescription(description)''': ''Function''. Generic method to update the description for all devices, groups and scenes. E.g.: device.setDescription(device.description .. ‘/nChanged by’.. item.trigger .. ‘at’ .. domoticz.time.raw). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setIcon(iconNumber)''': ''Function''. method to update the icon for devices. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setState(newState)''': ''Function''. Generic update method for switch-like devices. E.g.: device.setState(‘On’). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''resumeTimerPlan()''': ''Function''. Finds the most recent timer that should have fired today (before now) for this device, scene, or group and executes it immediately. Useful for restoring the correct state after a Domoticz restart or power cut. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. ```lua – Replay last timer for a device domoticz.devices(‘My Light’).resumeTimerPlan()
– Replay last timer for a scene domoticz.scenes(‘Evening Scene’).resumeTimerPlan()
– Replay last timer for a group domoticz.groups(‘All Lights’).resumeTimerPlan() ```</li>
<li>'''setValues(nValue,[ sValue1, sValue2, …])''': ''Function''. Generic alternative method to update device nValue, sValues. Uses domoticz JSON API to force subsequent pushes like influxdb and MQTT. nValue required but when set to nil it defaults to current nValue. sValue parms are optional and can be many. 3.0.8 If one of sValue parms is ‘parsetrigger’, subsequent eventscripts will be triggered.</li>
<li>'''state''': ''String''. For switches, holds the state like ‘On’ or ‘Off’. For dimmers that are on, it is also ‘On’ but there is a level attribute holding the dimming level. '''For selector switches''' (Dummy switch) the state holds the ''name'' of the currently selected level. The corresponding numeric level of this state can be found in the '''rawData''' attribute: <code>device.rawData[1]</code>.</li>
<li>'''signalLevel''': ''Number'' If applicable for that device then it will be from 0-12</li>
<li>'''switchType''': ''String''. See Domoticz devices table in Domoticz GUI(Switches tab). E.g. ‘On/Off’, ‘Door Contact’, ‘Motion Sensor’ or ‘Blinds’</li>
<li>'''sValue''': ''String''. Returns the sValue (string Value) of a device.</li>
<li>'''switchTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''timedOut''': ''Boolean''. Is true when the device couldn’t be reached.</li>
<li>'''unit''': ''Number''. Device unit. See device list in Domoticz’ settings for the unit.</li>
<li>'''update(< params >)''': ''Function''. Generic update method. Accepts any number of parameters that will be sent back to Domoticz. There is no need to pass the device.id here. It will be passed for you. Example to update a temperature: <code>device.update(0,12)</code>. This will eventually result in a commandArray entry <code>['UpdateDevice']='<idx>|0|12'</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''updateQuiet(nValue, sValue)''': ''Function''. 3.0.18 Uses the JSON/API to send nValue and/or sValue to domoticz (at least one should be supplied). Will update the device status in the GUI and trigger events but will not execute the action on the device. Only useful when the status in the GUI is not in line with the actual status. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li></ul>


=== Device attributes and methods for specific devices ===

Note that if you do not find your specific device type here you can always inspect what is in the <code>rawData</code> attribute. Please let us know that it is missing so we can write an adapter for it (or you can write your own and submit it). Calling <code>myDevice.dump()</code> will dump all attributes and values for myDevice to the Domoticz log.


==== Air quality ====

* '''co2''': ''Number''. PPM
* '''quality''': ''String''. Air quality string.
* '''updateAirQuality(ppm)''': Pass the CO2 concentration. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Alert sensor ====

* '''color''': ''Number''. Color of the alert. See domoticz color constants for possible values.
* '''text''': ''String''
* '''updateAlertSensor(level, text)''': ''Function''. Level can be domoticz.ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_YELLOW, ALERTLEVEL_ORANGE, ALERTLEVEL_RED. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 1-phase ====

* '''current''': ''Number''. Ampère.
* '''updateCurrent(current)''': ''Function''. Current in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 3-phase ====

* '''current1''', '''current2''', '''current3''' : ''Number''. Ampère.
* '''updateCurrent(current1, current2, current3)''': ''Function''. Currents in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Barometer sensor ====

* '''barometer'''. ''Number''. Barometric pressure.
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''updateBarometer(pressure, forecast)''': ''Function''. Update barometric pressure. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Counter, managed Counter, counter incremental ====

* '''counter''': ''Number''
* '''counterToday''': ''Number''. Today’s counter value.
* '''updateCounter(value)''': ''Function''. '''Overwrite current value for managed and standard counters; increment for incremental counters !!'''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateHistory( date, sValues )''': ''Strings'' 3.1.3 ''function'' Managed counter only! Used to write values to short or long term storage.

<syntaxhighlight lang="lua"> local mCounter = domoticz.devices('device name')
mCounter.updateHistory('2021-01-22', '10;1777193') -- Write to long term storage (meter_calendar table)
mCounter.updateHistory('2021-01-22 10:05:02', '10;1777193') -- Write to short term storage (meter table)</syntaxhighlight>
* '''incrementCounter(value)''': ''Function''. (counter incremental) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. To update with a complete new value you will have to do some calculation and take the counter divider into account.

<syntaxhighlight lang="lua"> local newValue = value
local iCounter = domoticz.devices('device name')
local counterDivider = x -- x is depending on the counter divider set for the device
iCounter.incrementCounter( ( -1 * iCounter.counter * counterDivider ) + newValue )</syntaxhighlight>
* '''valueQuantity''': ''String''. For counters.
* '''valueUnits''': ''String''.


==== Custom sensor ====

* '''sensorType''': ''Number''.
* '''sensorUnit''': ''String'':
* '''sensorValue''': 3.0.11 ''Number'' where applicable; else ''String'':
* '''updateCustomSensor(value)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Distance sensor ====

* '''distance''': ''Number''.
* '''updateDistance(distance)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Electric usage ====

* '''actualWatt''': ''Number''. Current Watt usage.
* '''WhActual''': ''Number''. Current Watt usage. (please use actualWatt)
* '''updateEnergy(energy)''': ''Function''. In Watt. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Evohome (controller) ====

* '''mode''': ''string'' 3.0.0.
* '''setMode(mode, dparm, action, ooc )''': ''Function''. set mode for controller. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_AUTOWITHRESET, domoticz.EVOHOME_MODE_AUTOWITHECO, domoticz.EVOHOME_MODE_AWAY, domoticz.EVOHOME_MODE_DAYOFF, domoticz.EVOHOME_MODE_CUSTOM or domoticz.EVOHOME_MODE_HEATINGOFF. dParm <optional> can be a future time string (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>), a future time object, a future time as number of seconds since epoch or a number representing a positive offset in minutes (max 1 year). action <optional> (1 = run on action script, 0 = disable), ooc <optional> (1 = only trigger the event & log on change, 0 = always trigger & log)


==== Evohome (hotWater) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''mode''': ''string''
* '''untilDate''': ''string in ISO 8601 format'' or n/a.
* '''setHotWater(state, mode, until)''': ''Function''. set HotWater Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE You can provide an until date (in ISO 8601 format for domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>).


==== Evohome (relay) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''level''': ''number'' (level percentage)
* '''active''': ''boolean'' (true when state is not equal to ‘Off’, false otherwise)


==== Evohome (zones) ====

* '''setPoint''': ''Number''.
* '''mode''': ''string'' .
* '''untilDate''': ''string in ISO 8601 format'' or n/a .
* '''updateSetPoint(setPoint, mode, until)''': ''Function''. Update set point. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE. You can provide an until date (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>). When leaving out untilDate for mode domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE the untilDate will be the next scheduled zone-update time/date. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Gas ====

* '''counter''': ''Number''. Value in m3
* '''counterToday''': ''Number''. Value in m3
* '''updateGas(usage)''': ''Function''. Usage in '''dm3''' (liters). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Group ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current group-name to new group-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleGroup()''': Toggles the state of a group. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Hardware 3.0.7 ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''isHardware''': ''Boolean''
* '''isPythonPlugin''': ''Boolean''
* '''type''': : ''String''
* '''typeValue''': : ''Number''


==== Humidity sensor ====

* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''updateHumidity(humidity, status)''': Update humidity. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Kodi ====

* '''kodiExecuteAddOn(addonId)''': ''Function''. Will send an Execute Addon command sending no parameters. Addon IDs are embedded in the addon configuration and are not to be confused with the Addon Name. For example: http://forums.homeseer.com/showthread.php?p=1213403.
* '''kodiPause()''': ''Function''. Will send a Pause command, only effective if the device is streaming.
* '''kodiPlay()''': ''Function''. Will send a Play command, only effective if the device was streaming and has been paused.
* '''kodiPlayFavorites([position])''': ''Function''. Will play an item from the Kodi’s Favorites list optionally starting at ''position''. Favorite positions start from 0 which is the default.
* '''kodiPlayPlaylist(name, [position])''': ''Function''. Will play a music or video Smart Playlist with ''name'' optionally starting at ''position''. Playlist positions start from 0 which is the default.
* '''kodiSetVolume(level)''': ''Function''. Set the volume for a Kodi device, 0 <= level <= 100.
* '''kodiStop()''': ''Function''. Will send a Stop command, only effective if the device is streaming.
* '''kodiSwitchOff()''': ''Function''. Will turn the device off if this is supported in settings on the device.


==== kWh, Electricity (instant and counter) ====

* '''actualWatt''': ''Number''. Actual usage in Watt.
* '''counterToday''': ''Number''.
* '''updateElectricity(power, energy)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''WhToday''': ''Number''. Total Wh usage of the day. Note the unit is Wh and not kWh!
* '''WhTotal''': ''Number''. Total Wh usage.
* '''WhActual''': ''Number''. Actual reading in Watt. Please use actualWatt


==== Leaf wetness ====

* '''wetness''': ''Number''. Wetness value
* '''updateWetness(wetness)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Logitech Media Server ====

* '''pause()''': ''Function''. Will pause the device if it was streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''play()''': ''Function''. If the device was off, it will turn on and start streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playFavorites([position])''': ''Function''. Will start the favorites playlist. <code>position</code> is optional (0 = default). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playlistID''': ''Nubmer''.
* '''setVolume(level)''': ''Function''. Sets the volume (0 <= level <= 100). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''startPlaylist(name)''': ''Function''. Will start the playlist by its <code>name</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Will stop the device (only effective if the device is streaming). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeUp()''': ''Function''. Will turn the device volume up with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeDown()''': ''Function''. Will turn the device volume down with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Lux sensor ====

* '''lux''': ''Number''. Lux level for light sensors.
* '''updateLux(lux)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Onkyo receiver ====

* '''onkyoEISCPCommand(command)'''. ''Function''. Sends an EISP command to the Onkyo receiver.


==== OpenTherm gateway ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== P1 Smart meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterToday''': ''Number''.
* '''usage1''', '''usage2''': ''Number''.
* '''return1''', '''return2''': ''Number''.
* '''updateP1(usage1, usage2, return1, return2, cons, prod)''': ''Function''. Updates the device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''usageDelivered''': ''Number''.


==== Percentage ====

* '''percentage''': ''Number''.
* '''updatePercentage(percentage)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Philips Hue Light ====

See switch below.


==== Pressure ====

* '''pressure''': ''Number''.
* '''updatePressure(pressure)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Rain meter ====

* '''rain''': ''Number'' (please note that this does return the rain total for today)
* '''rainRate''': ''Number''
* '''updateRain(rate, counter)''': ''Function''. (rate in mm * 100 per hour, counter is total in mm) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== RGBW(W) / Lighting Limitless/Applamp ====

* '''decreaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''getColor()'''; ''Function''. Returns table with color attributes or nil when color field of device is not set.
* '''increaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''setColor(r, g, b, br, cw, ww, m, t)''': ''Function''. Sets the light to requested color. r, g, b required, others optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. Meaning and limits of parms can be found [https://wiki.domoticz.com/Domoticz_API/JSON_URL's#Set_a_light_to_a_certain_color_or_color_temperature here].
* '''setColorBrightness()''': same as setColor
* '''setDiscoMode(modeNum)''': deprecated because only very limited supported and will be removed from API
* '''setHex(r, g, b)''': ''Function''. Sets the light to requested color. r, g, b required (decimal Values 0-255). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setHue(hue, brightness, isWhite)''': ''Function''. Sets the light to requested Hue. Hue and brightness required. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setKelvin(Kelvin)''': ''Function''. Sets Kelvin level of the light (For RGBWW devices only). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setNightMode()''': ''Function''. Sets the lamp to night mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setRGB(red, green, blue)''': ''Function''. Set the lamps RGB color. Values are from 0-255. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setWhiteMode()''': ''Function''. Sets the lamp to white mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scale weight ====

* '''weight''': ''Number''
* '''udateWeight()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scene ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current scene-name to new scene-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Security Panel ====

Create a security device:

# Set a security panel password in Domoticz settings.
# Activate the security panel ('''Setup > More Options > Security Panel''' and set it to '''Disarm''' (using your password)).
# Go to the device list in ('''Setup > Devices''') where it should show the security panel device under ‘Not used’.
# Add the device and give it a name.

Methods/attributes:

* '''armAway()''': Sets a security device to Armed Away. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''armHome()''': Sets a security device to Armed Home. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''disarm()''': Disarms a security device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''state''': ''String'': Same values as domoticz.security value.


==== Smoke detection ====

* '''activate()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''reset()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Solar radiation ====

* '''radiation'''. ''Number''. In Watt/m2.
* '''updateRadiation(radiation)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Soil moisture ====

* '''moisture'''. ''Number''. In centibars (cB).
* '''updateSoilMoisture(moisture)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Sound level ====

* '''level'''. ''Number''. In dB.
* '''updateSoundLevel(level)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Switch (dimmer, selector etc.) ====

There are many switch-like devices. Not all methods are applicable for all switch-like devices. You can always use the generic <code>setState(newState)</code> method.

* '''close()''': ''Function''. Set device to Close if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''dimTo(percentage)''': ''Function''. Switch a dimming device on and/or dim to the specified level. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''lastLevel''': Number. The level of a dimmer just before it was switched off. '''Note: lastLevel only shows you the previous level if you have a trigger for the device itself. So for instance you have a on-trigger for ‘myDimmer’ and the dimmer is set from 20% to 30%, in your script <code>myDimmer.level == 30</code> and <code>myDimmer.lastLevel == 20</code>. '''
* '''level''': ''Number''. For dimmers and other ‘Set Level..%’ devices this holds the level like selector switches.
* '''levelActions''': ''String''. |-separated list of url actions for selector switches.
* '''levelName''': ''String''. Current level name for selector switches.
* '''levelNames''': ''Table''. Table holding the level names for selector switch devices.
* '''levelVal''': ''Number''. Specific for selector switches.
* '''maxDimLevel''': ''Number''.
* '''open()''': ''Function''. Set device to Open if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOn()''': ''Function''. Set deviceStatus to on without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOff()''': ''Function''. set deviceStatus to off without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setLevel(percentage)''': ''Function''. Set device to a given level if it supports it (e.g. blinds percentage). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Set device to Stop if it supports it (e.g. blinds). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Switch device off it is supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Switch device on if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchSelector(<[level]|[levelname] >)''' : ''Function''. Switches a selector switch to a specific level ( levelname or level(numeric) required ) levelname must be exact, for level the closest fit will be picked. See the edit page in Domoticz for such a switch to get a list of the values). Levelname is only supported when level 0 (“Off”) is not removed Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleSwitch()''': ''Function''. Toggles the state of the switch (if it is togglable) like On/Off, Open/Close etc.


==== Temperature sensor ====

* '''temperature''': ''Number''
* '''updateTemperature(temperature)''': ''Function''. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Barometer sensor ====

* '''barometer''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''temperature''': ''Number''
* '''updateTempBaro(temperature, pressure, forecast)''': ''Function''. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity, Barometer sensor ====

* '''barometer''': ''Number''
* '''dewPoint''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHumBaro(temperature, humidity, status, pressure, forecast)''': ''Function''. forecast can be domoticz.BARO_NOINFO, BARO_SUNNY, BARO_PARTLY_CLOUDY, BARO_CLOUDY, BARO_RAIN. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET, HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity ====

* '''dewPoint''': ''Number''
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHum(temperature, humidity [, status] )''': ''Function''. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET or HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Text ====

* '''text''': ''String''
* '''updateText(text)''': Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat set point ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat Operating state 3.0.19 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat type 3 (Mertik) 3.0.15 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat 6 3.1.11 ====

Thermostat 6 devices come in several subtypes: Temp/Setpoint, Temp/Hum/Setpoint, Temp/Baro/Setpoint and Temp/Hum/Baro/Setpoint.

* '''setPoint''': ''Number''. The current set point.
* '''humidityStatusValue''': ''Number''. Mapped humidity status value (only for subtypes with humidity).
* '''updateSetPoint(setPoint)''': ''Function''. Update the set point. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)''': ''Function''. Update thermostat values. Parameters depend on the subtype:
** ''Temp/Setpoint'': <code>updateThermostat(temperature, setPoint)</code>
** ''Temp/Hum/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus)</code>
** ''Temp/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, nil, nil, barometer, forecast)</code>
** ''Temp/Hum/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)</code>
** <code>forecast</code> can be a string: <code>'noinfo'</code>, <code>'sunny'</code>, <code>'partlycloudy'</code>, <code>'cloudy'</code>, <code>'rain'</code> or a numeric value.
** <code>humidityStatus</code> can be a string: <code>'dry'</code>, <code>'normal'</code>, <code>'comfortable'</code>, <code>'wet'</code> or a numeric value. If omitted with humidity provided, it is auto-calculated.


==== UV sensor ====

* '''uv''': ''Number''. UV index.
* '''updateUV(uv)''': ''Function''. UV index. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Visibility ====

* '''visibility''': ''Number''. In km.
* '''updateVisibility(distance)''':Function*. In km. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Voltage ====

* '''voltage''': ''Number''.
* '''updateVoltage(voltage)''':Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Waterflow ====

* '''flow''': ''Number''. In L/m.
* '''updateWaterflow(flow)''':Function*. In L/m. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Wind ====

* '''chill''': ''Number''.
* '''direction''': ''Number''. Degrees.
* '''directionString''': ''String''. Formatted wind direction like N, SE.
* '''gust''': ''Number''. ( in meters / second, might change in future releases to Meters/Counters settings for Wind Meter )
* '''gustMs''': ''Number''. Gust ( in meters / second )
* '''temperature''': ''Number''
* '''speed''': ''Number''. Windspeed ( in the unit set in Meters/Counters settings for Wind Meter )
* '''speedMs''': ''Number''. Windspeed ( in meters / second )
* '''updateWind(bearing, direction, speed, gust, temperature, chill)''': ''Function''. Bearing in degrees, direction in N, S, NNW etc, speed in m/s, gust in m/s, temperature and chill in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Youless meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterDeliveredTotal''': ''Number''.
* '''powerYield''': ''String''.
* '''updateYouless(total, actual)''': ''Function''.


==== Zone heating ====

* '''setPoint''': ''Number''.
* '''heatingMode''': ''String''.


==== Z-Wave Fan mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Z-Wave Thermostat mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== Command options (delay, duration, event triggering) ===

Many dzVents device methods support extra options, like controlling a delay or a duration:

<syntaxhighlight lang="lua">
-- switch on for 2 minutes after 10 seconds
device.switchOn().afterSec(10).forMin(2)

-- switch on at a specic time / day
device.switchOn().at('09:00') -- earliest moment it will be 09:00 hr.
device.switchOn().at('08:53:30 on fri') -- earliest moment it will be Friday at 08:53:30
device.switchOn().at('08:53:30 on sat, sun') -- earliest moment it will be Saturday or Sunday at 08:53:30 (whatever comes first)

-- switch on for 2 minutes after a randomized delay of 1-10 minutes
device.switchOff().withinMin(10).forMin(2)
device.close().forMin(15)
device.open().afterSec(20)
device.open().afterMin(2)

-- switch on but do not trigger follow up events
device.switchOn().silent()

-- flash a light for 3 times
device.switchOn().forSec(2).repeatAfterSec(1, 3)

-- switch the device on but only if the current state isn't already on:
device.switchOn().checkFirst()
-- this is a short for:
if (device.state == 'Off') then
devices.switchOn()
end</syntaxhighlight>

==== Options ====

* '''at(hh:mm[:ss][ on [ ddd|dddd ] )''': ''Function''.3.0.1 Activates the command at a certain time [ on a certain day]
* '''afterHour(hours), afterMin(minutes), afterSec(seconds)''': ''Function''. Activates the command after a certain number of hours, minutes or seconds.
* '''cancelQueuedCommands()''': ''Function''. Cancels queued commands. E.g. you switch on a device after 10 minutes: <code>myDevice.switchOn().afterMin(10)</code>. Within those 10 minutes you can cancel that command by calling: <code>myDevice.cancelQueuedCommands()</code>.
* '''checkFirst()''': ''Function''. Checks if the '''current''' state of the device is different than the desired new state. If the target state is the same, no command is sent. If you do <code>mySwitch.switchOn().checkFirst()</code>, then no switch command is sent if the switch is already on. This command only works with switch-like devices. It is not available for toggle and dim commands, either.
* '''forHour(hours), forMin(minutes), forSec(seconds)''': ''Function''. Activates the command for the duration of hours, minutes or seconds. See table below for applicability and the warning on unexpected behavior of these functions.
* '''withinHour(hours), withinMin(minutes), withinSec(seconds)''': ''Function''. Activates the command within a certain period (specified in hours, minutes or seconds) ''randomly''. See table below for applicability.
* '''silent()''': ''Function''. No follow-up events will be triggered: <code>mySwitch.switchOff().silent()</code>.
* '''repeatAfterHour(hours, [number]), repeatAfterMin(minutes, [number]), repeatAfterSec(seconds, [number])''': ''Function''. Repeats the sequence ''number'' times after the specified duration (specified in hours, minutes, or seconds). If no ''number'' is provided, 1 is used. '''Note that <code>afterAAA()</code> and <code>withinAAA()</code> are only applied at the beginning of the sequence and not between the repeats!'''

Note that the actual switching or changing of the device is done by Domoticz and not by dzVents. dzVents only tells Domoticz what to do; if the options are not carried out as expected, this is likely a Domoticz or hardware issue.

'''Important note when using forAAA()''': Let’s say you have a light that is triggered by a motion detector. Currently the light is <code>Off</code> and you do this: <code>light.switchOn().forMin(5)</code>. What happens inside Domoticz is this: at t0 Domoticz issues the <code>switchOn()</code> command and schedules a command to restore the '''current''' state at t5 which is <code>Off</code>. So at t5 it will switch the light off.

If, however, ''before the scheduled <code>switchOff()</code> happens at t5'', new motion is detected and you send this command again at t2 then something unpredictable may seem to happen: ''the light is never turned off!'' This is what happens:

At t2 Domoticz receives the <code>switchOn().forMin(5)</code> command again. It sees a scheduled command at t5 and deletes that command (it is within the new interval). Then Domoticz performs the (unnecessary, it’s already on) <code>switchOn()</code> command. Then it checks the current state of the light which is <code>On</code>!! and schedules a command to return to that state at t2+5=t7. So, at t7 the light is switched on again. And there you have it: the light is not switched off and never will be because future commands will always be checked against the current on-state.

That’s just how it works and you will have to deal with it in your script. So, instead of simply re-issuing <code>switchOn().forMin(5)</code> you have to check the switch’s state first:

<syntaxhighlight lang="lua">if (light.active) then
light.switchOff().afterMin(5)
else
light.switchOn().forMin(5)
end</syntaxhighlight>
or issue these two commands ''both'' as they are mutually exclusive:

<syntaxhighlight lang="lua">light.switchOff().checkFirst().afterMin(5)
light.switchOn().checkFirst().forMin(5)</syntaxhighlight>

==== Availability ====

Some options are not available to all commands. All the options are available to device switch-like commands like <code>myDevice.switchOff()</code>, <code>myGroup.switchOn()</code> or <code>myBlinds.open()</code>. For updating (usually Dummy ) devices like a text device <code>myTextDevice.updateText('zork')</code> you can only use <code>silent()</code>. For thermostat setpoint devices and snapshot command silent() is not available. For commands for which dzVents must use openURL, only <code>at()</code> and <code>afterAAA()</code> methods are available. These commands are mainly the setAaaaa() commands for RGBW type devices.

See table below

{| class="wikitable"
!width="17%"| option
!align="center" width="10%"| state changes
!align="center" width="11%"| update commands
!align="center" width="12%"| user variables
!align="center" width="12%"| updateSetpoint
!align="center" width="8%"| snapshot
!align="center" width="10%"| triggerIFTTT
!align="center" width="12%"| execute ShellCommand
!align="center" width="12%"| emitEvent
|-
| <code>afterAAA()</code>1
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>at()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>forAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>withinAAA()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| •
|-
| <code>silent()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>repeatAfterAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>checkFirst()</code>
|align="center"| • 2
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>cancelQueuedCommands()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a

|}

==== Notes on table ====

* '''Note 1''': AAA is a placeholder for <code>Min/Sec/Hour</code> affix e.g. <code>afterMin()</code>.
* '''Note 2''': for <code>domoticz.openURL()</code> only <code>at()</code>, <code>afterAAA()</code> and <code>withinAAA()</code> is available.
* '''Note 3''': Note 2 also applies for all commands depending on openURL (like rgbwwDevice.setAaa() commands).
* '''Note 4''': Including dimTo, switchSelector, setLevel and similar methods.


==== Follow-up event triggers ====

Normally if you issue a command, Domoticz will immediately trigger follow-up events, and dzVents will automatically trigger defined event scripts. If you trigger a scene, all devices in that scene will issue a change event. If you have event triggers for these devices, they will be executed by dzVents. If you don’t want this to happen, add <code>.silent()</code> to your commands (exception is updateSetPoint).


=== Create your own device adapter ===

If your device is not recognized by dzVents, you can still operate it using the generic device attributes and methods. It is much nicer, however, to have device specific attributes and methods. Existing recognized adapters are in <code>/path/to/domoticz/dzVents/runtime/device-adapters</code>. Copy an existing adapter and adapt it to your needs. You can turn debug logging on and inspect the file <code>domoticzData.lua</code> in the dzVents folder. There you will find the unique signature for your device type. Usually it is a combination of deviceType and deviceSubType, but you can use any of the device attributes in the <code>matches</code> function. The matches function checks if the device type is suitable for your adapter and the <code>process</code> function actually creates your specific attributes and methods. Also, if you call <code>myDevice.dump()</code> you will see all attributes and methods and the attribute <code>_adapters</code> shows you a list of applied adapters for that device. Finally, register your adapter in <code>Adapters.lua</code>. Please share your adapter when it is ready and working.


== Variable object API (user variables) ==

User variables created in Domoticz have these attributes and methods:


=== Variable attributes and methods ===

* '''changed''': ''Boolean''. Was the variable updated. '''Note''': update does not necessarily means the variable value or type changed.
* '''date''': ''Date''. If type is domoticz.DATE. See lastUpdate for the sub-attributes.
* '''id''': ''Number''. Index of the variable.
* '''lastUpdate''': ''[[#Time_object|Time Object]]''
* '''name''': ''String''. Name of the variable
* '''rename(newName)''': ''Function''. Change current variable name to new variable name. (does not support timing options)
* '''set(value)''': Tells Domoticz to update the variable. Supports timing options. See [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|above]].
* '''time''': ''Date''. If type is domoticz.TIME. See lastUpdate for the sub-attributes.
* '''type''': ''String''. Can be domoticz.INTEGER, domoticz.FLOAT, domoticz.STRING, domoticz.DATE, domoticz.TIME.
* '''value''': ''String|Number|Date|Time''. Value of the variable.

<syntaxhighlight lang="lua">
return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
end
end
}
</syntaxhighlight>

== Time object ==

Many attributes represent a moment in time, like <code>myDevice.lastUpdate</code> or <code>domoticz.time</code>. In dzVents, a time-like attribute is an object with properties and methods which make your life easier.

<syntaxhighlight lang="lua"> print(myDevice.lastUpdate.minutesAgo)
print(myDevice.lastUpdate.daysAgo)

-- compare two times
print(domoticz.time.compare(myDevice.lastUpdate).secs))</syntaxhighlight>
You can also create your own:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00') -- must be this format!!</syntaxhighlight>
If you don’t pass a time string:

<syntaxhighlight lang="lua"> local Time = require('Time')
local currentTime = Time()</syntaxhighlight>
Use this in combination with the various dzVents time attributes:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00')

local tonight = Time(domoticz.time.rawDate .. ' 20:00:00')
print (tonight.getISO())
-- will print something like: 2016-12-12T20:00:00Z
print(t.minutesAgo) -- difference from 'now' in minutes

-- and you can feed it with all same rules as you use
-- for the timer = { .. } section:
if (t.matchesRule('at 16:00-21:00')) then
-- t is in between 16:00 and 21:00
end

-- very powerful if you want to compare two time instances:
local anotherTime = Time('...') -- fill-in some time here
print(t.compare(anotherTime).secs) -- diff in seconds between t and anotherTime.</syntaxhighlight>

=== System event API ===

If you have a dzVents script that is triggered by a system-event in Domoticz then the second parameter passed to the execute function will be a ''system'' object. The object.type = system-event that triggered the script. ( object.isSystemEvent: true) For backups the object also contains location and durationin seconds.


=== Time properties and methods ===

Creation:

<syntaxhighlight lang="lua">local Time = require('Time')
local now = Time() -- current time
local someTime = Time('2017-12-31 22:19:15')
local utcTime = Time('2017-12-31 22:19:15', true)</syntaxhighlight>
Creation:

<syntaxhighlight lang="lua">local someTime = domoticz.time.addMinutes(30) -- someTime = domoticz time object for now + 30 minutes
local someTime = domoticz.time.makeTime() -- someTime = new domoticz time object.</syntaxhighlight>
* '''addAAA(offset)''': ''time object''. time object with given offset (positive or negative. AAA is a placeholder for <code>Seconds, Minutes, Hours or Days</code> affix e.g. `addHours(-2)
* '''civTwilightEndInMinutes''': ''Number''. Minutes from midnight until civTwilightEnd.
* '''civTwilightStartInMinutes''':''Number''. Minutes from midnight until civTwilightStart.
* '''compare(time)''': ''Function''. Compares the current time object with another time object. ''Make sure you pass a Time object!'' Returns a table (all values are ''positive'', use the compare property to see if ''time'' is in the past or future):
** '''milliseconds''': Total difference in milliseconds.
** '''seconds''': Total difference in whole seconds.
** '''minutes''': Total difference in whole minutes.
** '''hours''': Total difference in whole hours.
** '''days''': Total difference in whole days.
** '''compare''': 0 = both are equal, 1 = ''time'' is in the future, -1 = ''time'' is in the past.
* '''dateToDate( dateString, sourceFormat, targetFormat[ , offSet] )''':3.0.17 ''Function'': Returns a reformatted datestring. dateString is a formatted date and source- and targetFormat are representations of the dateString elements and their locations in the string (see examples in dateToTimestamp) . Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'dddd dd mmmm hh:MM:ss', 1 ) -- > 'Friday 31 December 23:31:06'
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'ddd dd mmm hh:MM:ss', -3600 * 24 - 3 )) -- > 'Thu 30 Dec 23:31:02'</syntaxhighlight>
* '''dateToTimestamp([ dateString [,control] ] )''': ''Function'': Returns ''Number'' representing time since epoch in seconds. dateString is a formatted date and control is a representation of the dateString elements and their location in the string. Default control is ‘yyyy-mm-dd hh:MM’. recognized controls are either a Lua pattern string or a string containing following codes:

<syntaxhighlight lang="lua"> dddd -- full weekdayname(e.g. Wednesday) language depends on locale
ddd -- abbreviated weekdayname(e.g. Wed) language depends on locale
dd -- day of the month {[01-31]
mmmm -- full monthname(e.g September) language depends on locale
mmm -- abbreviated monthname(e.g. Sep) language depends on locale
mm -- month [01-12]
yyyy -- 4 digit year
yy -- 2 digit year
hh -- hour 24-hour clock
ii -- hour 12-hour clock
MM -- minute
ss -- second
W -- weeknumber [01-53]
w -- weekday{[0-6] Sunday-Saturday
datm -- date and time (e.g. 09/16/98 23:48:10) format depends on locale
mer -- either "AM" or "PM" locale
date -- date(e.g. 09/16/98) format depends on locale
time -- time (e.g. 23:48:10)

-- examples:
domoticz.time.dateToTimestamp('2020-12-31 23:59')) -- > 1609455540
domoticz.time.dateToTimestamp('2020-12-31 23:59:01','yyyy-mm-dd hh:MM:ss')) -- > 1609455541
domoticz.time.dateToTimestamp('December 31, 23:59:02','mmmm dd, hh:MM:ss')) -- > 1609455542
domoticz.time.dateToTimestamp('2020-12-31 23:59:03','(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)' )) -- > 1609455543
domoticz.time.dateToTimestamp('20201231235904','(%d%d%d%d)(%d%d)(%d%d)(%d%d)(%d%d)(%d%d)')) -- > 1609455544</syntaxhighlight>
* '''day''': ''Number''
* '''dayAbbrOfWeek''': ''String''. sun,mon,tue,wed,thu,fri or sat
* '''daysAgo''': ''Number''
* '''dayName''': ''String''. complete name Sunday, Monday, etc
* '''dDate''': ''Number''. timestamp (seconds since 01/01/1970 00:00)
* '''getISO''': ''Function''. Returns the ISO 8601 formatted date.
* '''hour''': ''Number''
* '''hoursAgo''': ''Number''. Number of hours since the last update.
* '''isdst''': ''Boolean''. 3.0.18 Indicates if time is in the daylight saving period
* '''isToday''': ''Boolean''. Indicates if time is today
* '''isUTC''': ''Boolean''.
* '''makeTime(string | table,[isUTC])''': ''domoticz time object''. returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. isUTC defaults to false.
* '''matchesRule(rule) ''': ''Function''. Returns true if the rule matches with the time. See [[#timer_trigger_rules|time trigger rules]] for rule examples.
* '''millisecondsAgo''': ''Number''. Number of milliseconds since the last update.
* '''minutes''': ''Number''
* '''minutesAgo''': ''Number''. Number of minutes since the last update.
* '''minutesSinceMidnight''': ''Number''
* '''month''': ''Number''
* '''monthAbbrName''': String. jan, feb, mar, etc
* '''monthName''': ''String''. January, February, etc
* '''msAgo''': ''Number''. Number of milliseconds since the last update.
* '''raw''': ''String''. Generated by Domoticz
* '''rawDate''': ''String''. Returns the date part of the raw data.
* '''rawDateTime''': ''String''. Combined date / time formatted as domoticz does in API / JSON returns (rawDate .. ’ ’.. rawTime )
* '''rawTime''': ''String''. Returns the time part of the raw data as HH:MM:SS
* '''seconds''': ''Number''
* '''secondsSinceMidnight''': ''Number''
* '''secondsAgo''': ''Number''. Number of seconds since the last update.
* '''sunsetInMinutes''': ''Number''. Minutes from midnight until sunset.
* '''sunriseInMinutes''': ''Number''. Minutes from midnight until sunrise.
* '''solarnoonInMinutes''': ''Number''. 3.0.11 Minutes from midnight until solarnoon.
* '''time''': ''String''. Returns the time part of the raw data as HH:MM
* '''timestampToDate([ [ timestamp ] , [ pattern ] ,[ offSet ] )''': ''function''. Returns a datestring. timestamp is number of seconds since epoch (default = now) , pattern is a string as explained in this wiki at the description of the domoticz.time.dateToTimestamp function (default = ‘yyyy-mm-dd hh:MM:ss’). Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.timestampToDate(10,'date time') --> '01/01/70 01:00:10'
domoticz.time.timestampToDate(60,'ddd mm mmm yyyy ii:MM mer','date time') --> 'Thu 01 Jan 1970 01:01 AM''
domoticz.time.timestampToDate(1598077445,'dd/mm/yy ii:MM mer nZero') --> '22/08/20 8:24 AM'</syntaxhighlight>
* '''toUTC(string | table,[offset])''': ''domoticz time object''. 3.0.9 returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. offset defaults to 0.
* '''utcSystemTime''': ''Table''. UTC system time (only when in UTC mode):
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''utcTime''': ''Table''. Time stamp in UTC time:
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''year''': ''Number''
* '''wday''': ''Number'' day of the week. Sunday = 1, Saturday = 7
* '''week''': ''Number'' week of the year

'''Note: it is currently not possible to change the domoticz.time object instance.''' ( but you can create a new one with- or without an offset)


== Shared helper functions ==

It is not unlikely that at some point you want to share Lua code among your scripts. Normally in Lua you would have to create a module and require that module in all you scripts. But dzVents makes that easier for you: Inside your scripts folder or in Domoticz’ GUI web editor, create a <code>global_data.lua</code> script (same as for global persistent data) and feed it with this code:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(param1, param2)
-- do your stuff
end,
MY_CONSTANT = 100 -- doesn't have to be a function
}
}</syntaxhighlight>
Save the file and then you can use myHandyFunction everywhere in your event scripts:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction('bla', 'boo')
print(domoticz.helpers.MY_CONSTANT)
end
}</syntaxhighlight>
No <code>require</code> or <code>dofile</code> is needed.

'''Important note: if you need to access the domoticz object in your helper function you have to pass it as a parameter:'''

Example:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(domoticz, param1, param2)
-- do your stuff
domoticz.log('Hey')
end
}
}</syntaxhighlight>
And pass it along:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction(domoticz, 'bla', 'boo')
end
}</syntaxhighlight>
'''Note''': there can be only '''one''' <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.


== Requiring your own modules ==

If you don’t want to use the helpers support, but you want to require your own modules, place them either in <code>/path/to/domoticz/scripts/dzVents/modules</code> or <code>/path/to/domoticz/scripts/dzVents/scripts/modules</code> as these folders are already added to the Lua package path. You can just require those modules: <code>local myModule = require('myModule')</code>


= Persistent data =

In many situations you need to store a device state or other information in your scripts for later use. Like knowing what the state was of a device the previous time the script was executed or what the temperature in a room was 10 minutes ago. Without dzVents, you had to resort to user variables. These are global variables that you create in the Domoticz GUI and that you can access in your scripts like: domoticz.variables(‘previousTemperature’).

Now, for some this is rather inconvenient and they want to control this state information in the event scripts themselves or want to use all of Lua’s variable types. dzVents has a solution for that: '''persistent script data'''. This can either be on the script level or on a global level.


== Script level persistent variables ==

The values in persistent script variables persist and can be retrieved in the next script run.

For example, send a notification if a switch has been activated 5 times:

<syntaxhighlight lang="lua"> return {
on = {
devices = { 'MySwitch' }
},
data = {
counter = { initial = 0 }
},
execute = function(domoticz, switch)
if (domoticz.data.counter == 5) then
domoticz.notify('The switch was pressed 5 times!')
domoticz.data.counter = 0 -- reset the counter
else
domoticz.data.counter = domoticz.data.counter + 1
end
end
}</syntaxhighlight>
The <code>data</code> section defines a persistent variable called <code>counter</code>. It also defines an initial value. From then on you can read and set the variable in your script.

You do not have to provide an initial value though. In that case the initial value is ''nil'':

<syntaxhighlight lang="lua"> return {
--
data = {
'x', 'y', 'z' -- note the quotes
},
execute = function(domoticz, item)
print(tostring(domoticz.data.x)) -- prints nil
end
}</syntaxhighlight>
You can define as many variables as you like and put whatever value in there that you like. It doesn’t have to be just a number. Just don’t put something in there with functions (well, they are filtered out actually).


=== Size matters and watch your speed!! ===

If you include tables (or arrays) in the persistent data, beware to not let them grow. It will definitely slow down script execution because dzVents has to serialize and deserialize the data. It is better to use the historical option as described below.


=== Re-initializing a variable ===

You can re-initialize a persistent variable and re-apply the initial value as defined in the data section:

<syntaxhighlight lang="lua">return {
on = { .. },
data = {
x = { initial = 'initial value' }
},
execute = function(domoticz, item)
if (domoticz.data.x ~= 'initial value') then
domoticz.data.initialize('x')
print(domoticz.data.x) -- will print 'initial value'
end
end
}</syntaxhighlight>
Note that <code>domoticz.data.initialize('<varname>')</code> is just a convenience method. You can of course create a local variable in your module holding the initial value and use it in your data section and your execute function.


== Global persistent variables ==

Script level variables are only available in the scripts that define them, but global variables can be accessed and changed in every script. To utilize global persistent variables, create a script file called <code>global_data.lua</code> in your scripts folder with this content (same file where you can also put your shared helper functions):

<syntaxhighlight lang="lua"> return {
helpers = {},
data = {
peopleAtHome = { initial = false },
heatingProgramActive = { initial = false }
}
}</syntaxhighlight>
Just define the variables that you need and access them in your scripts:

<syntaxhighlight lang="lua"> return {
on = {
devices = {'WindowSensor'}
},
execute = function(domoticz, windowSensor)
if (domoticz.globalData.heatingProgramActive
and windowSensor.state == 'Open') then
domoticz.notify("Hey don't open the window when the heating is on!")
end
end
}</syntaxhighlight>
'''Note''': there can be only one <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.

You can use <code>domoticz.globalData.initialize('<varname>')</code> just as like <code>domoticz.data.initialize('<varname>')</code>.


== A special kind of persistent variables: ''history = true'' (Historical variables API) ==

In some situations, storing a previous value for a sensor is not enough, and you would like to have more previous values. For example, you want to calculate an average over several readings. Of course you can define a persistent variable holding a table:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
previousData = { initial = {} }
},
execute = function(domoticz, sensor)
-- add new data
table.insert(domoticz.data.previousData, sensor.temperature)

-- calculate the average
local sum = 0, count = 0
for i, temp in pairs(domoticz.data.previousData) do
sum = sum + temp
count = count + 1
end
local average = sum / count
end
}</syntaxhighlight>
The problem with this is that you have to do a lot of bookkeeping to make sure that there isn’t too much data to store (see [[#How_does_the_storage_stuff_work.3F|below for how it works]]) . Fortunately, dzVents has done this for you:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
temperatures = { history = true, maxItems = 10 }
},
execute = function(domoticz, sensor)
-- add new data
domoticz.data.temperatures.add(sensor.temperature)

-- average
local average = domoticz.data.temperatures.avg()

-- maximum value in the past hour:
local max = domoticz.data.temperatures.maxSince('01:00:00')
end
}</syntaxhighlight>

=== Defining ===

Define a script variable or global variable in the data section and set <code>history = true</code>:

<syntaxhighlight lang="lua"> …
data = {
var1 = { history = true, maxItems = 10, maxHours = 1, maxMinutes = 5 }
}</syntaxhighlight>
* '''maxItems''': ''Number''. Controls how many items are stored in the variable. maxItems has precedence over maxHours and maxMinutes.
* '''maxHours''': ''Number''. Data older than <code>maxHours</code> from now will be discarded. E.g., if set to 2, then data older than 2 hours will be removed at the beginning of the script.
* '''maxMinutes''': ''Number''. Same as maxHours but, you guessed it: for minutes this time.. All these options can be combined. '''Reminder: don’t store too much data. Only put in what you really need!'''


=== Adding data ===

Add new values to a historical variable:

<pre>domoticz.data.myVar.add(value)</pre>
As soon as this new value is put on top of the list, the older values shift one place down the line. If <code>maxItems</code> is reached, then the oldest value will be discarded. ''All methods, like calculating averages or sums, will immediately use this new value!'' If you don’t want this to happen, set the new value at the end of your script or after you have done your analysis.

Any kind of data may be stored in the historical variable: numbers, strings, but also more complex data like tables. However, in order to use the [[#Statistical_functions|statistical methods]], numeric values are required.


=== Accessing values in historical variables ===

Values in a historical variable are indexed, where index 1 is the newest value, 2 is the second newest, and so on:

<pre>local item = domoticz.data.myVar.get(5)
print(item.data)</pre>
However, all data in the storage are time-stamped:

<pre>local item = domoticz.data.myVar.getLatest()
print(item.time.secondsAgo) -- access the time stamp
print(item.data) -- access the data</pre>
The time attribute by itself is a table with many properties that help you inspect the data points more easily. See [[#Time_object|Time Object]] for all attributes and methods.


==== Index ====

All data in the set can be addressed using an index. The item with index = 1 is the youngest, and the item with the highest index is the oldest. Beware, if you have called <code>add()</code> first, then the first item is that new value! You can always check the size of the set by inspecting <code>myVar.size</code>.


==== Time specification (''timeAgo'') ====

Every data point in the set has a timestamp and the set is ordered so that the youngest item is the first and the oldest item the last. Many functions require a moment in the past to be specified by passing a string in the format '''<code>hh:mm:ss</code>''', where ''hh'' is the number of hours ago, ''mm'' the number of minutes and ''ss'' the number of seconds. The times are added together, so you don’t have to consider 60 minute boundaries, etc. A time specification of <code>12:88:03</code> is valid, and points to the data point at or around <code>12*3600 + 88*60 + 3 = 48.483 seconds</code> in the past.

Example:

<pre>-- get average for the past 30 minutes:
local avg = myVar.avgSince('00:30:00')</pre>

==== Getting data points ====

* '''get(idx)''': Returns the idx-th item in the set. Same as <code>myVar.storage[idx]</code>.
* '''getAtTime([[#Time_specification_.28timeAgo.29|timeAgo]])''': Returns the data point ''closest'' to the moment as specified by <code>timeAgo</code> and the index in the set. So, <code>myVar.getAtTime('1:00:00')</code> returns the item that is closest to one hour old. It may be a bit younger or a bit older than 1 hour. The second return value is the index in the set: <code>local item, index = myVar.getAtTime('1:00:00')</code>
* '''getLatest( )''': Returns the youngest item in the set. Same as <code>print(myVar.get(1).data)</code>.
* '''getOldest( )''': Returns the oldest item in the set and the index. Same as <code>print(myVar.get(myVar.size).data)</code>. Note that the index is always the same as the total size. <code>local item, index = myVar.getOldest()</code>.
* '''size''': Return the number of data points in the set.
* '''subset( [fromIdx], [toIdx] )''': Returns a subset of the stored data. Default value, if omitted, of <code>fromIdx</code> is 1. Omitting <code>toIdx</code> takes all items until the end of the set (oldest). E.g., <code>myVar.subset()</code> returns all data. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''subsetSince( [[#Time_specification_.28timeAgo.29|timeAgo]] )''': Returns a subset of the stored data since the relative time specified by timeAgo. So calling <code>myVar.subsetSince('00:60:00')</code> returns all items that have been added to the list in the past 60 minutes. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''reset( )''': Removes all the items from the set. It could be a good practice to do this often when you know you don’t need older data. For instance, when you turn on a heater and you just want to monitor rising temperatures starting from this moment when the heater is activated. If you don’t need data points from before, then you may call reset.


==== Looping through the data: iterators ====

Similar to the iterators as described [[#Looping_through_the_collections:_iterators|above]], there are convenience methods to make looping through the data set easier.

* '''forEach(function)''': Loop over all items in the set: E.g.: <code>myVar.forEach( function( item, index, collection) ... end )</code>
* '''filter(function)''': Create a filtered set of items. The function receives the item and returns true if the item is in the result set. E.g. get a set with item values larger than 20: <code>subset = myVar.filter( function (item) return (item.data > 20) end )</code>.
* '''find(function)''': Search for a specific item in the set: E.g. find the first item with a value higher than 20: <code>local item = myVar.find( function (item) return (item.data > 20) end )</code>.
* '''reduce(function, initial)''': Loop over all items in the set and do some calculation with it. You call reduce with the function and the initial value. Each iteration the function is called with the accumulator. The function does something with the accumulator and returns a new value for it. Once you get the hang of it, it is very powerful. Best to give an example. To sum all values:

<syntaxhighlight lang="lua"> local sum = myVar.reduce(function(acc, item)
local value = item.data
return acc + value
end, 0)</syntaxhighlight>
Suppose you want to get data points older than 45 minutes and count the values that are higher than 20 (of course there are more ways to do this):

<syntaxhighlight lang="lua"> local myVar = domoticz.data.myVar

local olderItems = myVar.filter(function (item)
return (item.time.minutesAgo > 45)
end)

local count = olderItems.reduce(function(acc, item)
if (item.data > 20) then
acc = acc + 1
end
return acc
end, 0)

print('Found ' .. tostring(count) .. ' items')</syntaxhighlight>

==== Statistical functions ====

Statistical functions require ''numerical'' data in the set. If the set is just numbers you can do this:

<pre>myVar.add(myDevice.temperature) -- adds a number to the set
myVar.avg() -- returns the average</pre>
If, however, you add more complex data or you want to do a computation first, then you have to ''tell dzVents how to get a numeric value from these data''. So let’s say you do this to add data to the set:

<pre>myVar.add( { 'person' = 'John', waterUsage = u })</pre>
Where <code>u</code> is a variable that got its value earlier. If you want to calculate the average water usage, then dzVents will not be able to do this because it doesn’t know the value is actually in the <code>waterUsage</code> attribute! You will get <code>nil</code>.

To make this work you have to provide a '''getValue function''' in the data section when you define the historical variable:

<syntaxhighlight lang="lua"> return {
active = true,
on = {...},
data = {
myVar = {
history = true,
maxItems = 10,
getValue = function(item)
return item.data.waterUsage -- return number!!
end
}
},
execute = function()...end
}</syntaxhighlight>
This function tells dzVents how to get the numeric value for a data item. '''Note: the <code>getValue</code> function has to return a number!'''.

Of course, if you don’t intend to use any of these statistical functions you can put whatever you want in the set.

<ul>
<li>'''avg( [fromIdx], [toIdx], [default] )''': Calculates the average of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''avgSince([[#Time_specification_.28timeAgo.29|timeAgo]], default )''': Calculates the average of all data points since <code>timeAgo</code>. Returns <code>default</code> if there are no data, otherwise 0. E.g.: <code>local avg = myVar.avgSince('00:30:00')</code> returns the average over the past 30 minutes.</li>
<li>'''med( [fromIdx], [toIdx], [default] )''': Calculates the median of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''min( [fromIdx], [toIdx] )''': Returns the lowest value in the range defined by fromIdx and toIdx.</li>
<li>'''minSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''min''' but now within the <code>timeAgo</code> interval.</li>
<li>'''max( [fromIdx], [toIdx] )''': Returns the highest value in the range defined by fromIdx and toIdx.</li>
<li>'''maxSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''max''' but within the <code>timeAgo</code> interval.</li>
<li>'''sum( [fromIdx], [toIdx] )''': Returns the summation of all values in the range defined by fromIdx and toIdx. It will return 0 when there are no data.</li>
<li>'''sumSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''sum''' but within the <code>timeAgo</code> interval. It will return 0 when there are no data in the interval.</li>
<li>** delta(fromIdx, toIdx, [smoothRange], [default] )**: Returns the delta (difference) between items specified by <code>fromIdx</code> and <code>toIdx</code>. Provide a valid range (no <code>nil</code> values). [Supports data smoothing]. (#Data_smoothing) when providing a <code>smoothRange</code> value. Returns <code>default</code> if there is not enough data. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta(2, 5, 3)</code>.</li>
<li>'''delta2( fromIdx, toIdx, [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''delta''' but now you can control if the smooth values for the ''from-item'' and the ''to-item'' separately. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta2(2, 5, 3, 3)</code>.</li>
<li>'''deltaSince([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRange], [default] )''': Same as '''delta''' but within the <code>timeAgo</code> interval. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSince('00:00:10', 3)</code>.</li>
<li>'''deltaSinceOrOldest([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''deltaSince''' but it will take the oldest value in the set if ''timeAgo'' is older than the age of the entire set. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSinceOrOldest('00:00:10', 3, 3)</code>.</li>
<li>'''localMin( [smoothRange], default )''':</li>
<li>'''localMin( [smoothRange], default )''': Returns the first minimum value (and the item holding the minimal value) in the past. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value. For example, given this range of values in the data set (from new to old): <code>10 8 7 5 3 4 5 6</code>, it will return <code>3</code> because older values ''and'' newer values are higher: a local minimum. Use this if you want to know at what time a temperature started to rise after it had been dropping. E.g.:
<pre> local value, item = myVar.localMin()
print(' minimum was : ' .. value .. ': ' .. item.time.secondsAgo .. ' seconds ago' )</pre></li>
<li>'''localMax([smoothRange], default)''': Same as '''localMin''' but for the maximum value. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value.</li>
<li>'''smoothItem(itemIdx, [smoothRange])''': Returns a the value of <code>itemIdx</code> in the set but smoothed by averaging with its neighbors. The number of neighbors is set by <code>smoothRange</code>. See [[#Data_smoothing|Data smoothing]].</li></ul>


==== Data smoothing ====

Example: Suppose you store temperatures in the historical variable. These temperatures may have extremes. Perhaps these extremes could be due to sensor reading errors. In order to reduce the effect of these so-called spikes, you could smooth out values. It is like blurring the data. The Raw column is your temperatures. The other columns are calculated by averaging the neighbors. For item 10 the calculations are:

<pre>Range=1 for time10 = (25 + 31 + 29) / 3 = 28,3
Range=2 for time10 = (16 + 25 + 31 + 29 + 26) / 5 = 25,4</pre>

{| class="wikitable" style="text-align: center; align="center" width="30% height:10px;"
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"| time
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| raw
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=1
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=2
|-
| '''1'''
| 18
| 20,0
| 21,7
|-
| '''2'''
| 22
| 21,7
| 25,0
|-
| '''3'''
| 25
| 27,3
| 24,6
|-
| '''4'''
| 35
| 27,7
| 26,6
|-
| '''5'''
| 23
| 28,7
| 27,6
|-
| '''6'''
| 28
| 26,0
| 25,8
|-
| '''7'''
| 27
| 23,7
| 23,8
|-
| '''8'''
| 16
| 22,7
| 25,4
|-
| '''9'''
| 25
| 24,0
| 25,6
|-
| '''10'''
| 31
| 28,3
| 25,4
|-
| '''11'''
| 29
| 28,7
| 29,2
|-
| '''12'''
| 26
| 30,0
| 30,2
|-
| '''13'''
| 35
| 30,3
| 30,2
|-
| '''14'''
| 30
| 32,0
| 30,4
|-
| '''15'''
| 31
| 30,3
| 30,8
|-
| '''16'''
| 30
| 29,7
| 28,2
|-
| '''17'''
| 28
| 26,7
| 28,6
|-
| '''18'''
| 22
| 27,3
| 26,2
|-
| '''19'''
| 32
| 24,3
| 25,3
|-
| '''20'''
| 19
| 25,5
| 24,3
|}
A chart illustrates it more clearly. The red line is not smoothed and has more spikes than the others:

[[File:dzvents-smoothing.png|frame|none|alt=|Smoothing]]

Usually a range of 1 or 2 is sufficient when providing a smoothing range to statistical functions. I suggest smoothing when checking deltas, local minimums and maximums.


== How does the storage stuff work? ==

For every script file that defines persisted variables (using the <code>data={ … }</code> section), dzVents will create storage file with the name <code>__data_scriptname.lua</code> in a subfolder called <code>data</code>. You can always delete these data files or the entire storage folder if there is a problem with it:

<pre>domoticz/
scripts/
dzVents/
data/
__data_yourscript1.lua
__data_yourscript2.lua
__data_global_data.lua
examples/
generated_scripts/
scripts/
yourscript1.lua
yourscript2.lua
global_data.lua</pre>
If you dare to, you can watch inside these files. Every time some data are changed, dzVents will stream the changes back into the data files. '''Again, make sure you don’t put too much stuff in your persistent data as it may slow things down too much.'''


= Asynchronous HTTP requests =

dzVents allows you to make asynchronous HTTP request and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use os functions like <code>curl</code> or <code>wget</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz will terminate the script with a message that it took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to make an http call and it is determined by how you use the <code>domoticz.openURL()</code> command. The simplest form simply calls <code>openURL</code> on the domoticz object with only the url as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.openURL('http://domain/path/to/something?withparameters=1')</syntaxhighlight>
After your script is finished, Domoticz will make the request that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a url you pass in a table with all the parameters to make the request '''and''' your provide a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.openURL({
url = 'http://domain/path/to/something',
method = 'POST',
callback = 'mycallbackstring',
postData = {
paramA = 'something',
paramB = 'something else'
}
})
end
}</syntaxhighlight>
In this case, Domoticz will make the request (a POST in this case), and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
httpResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if (response.ok) then -- success
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every 5 seconds'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = '...',
callback = 'trigger'
})
end
if (item.isHTTPResponse) then
if (item.ok) then
...
end
end
end
}</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.openURL(options)''': ''options'' is a Lua table:

* '''url''': ''String''.
* '''method''': ''String''. Optional. Either <code>'GET'</code> (default), <code>'POST'</code>, <code>'PUT'</code>3.0.2 or <code>'DELETE'</code>3.0.2 .
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to trigger the callback handler script(s).
* '''headers''': ''Table / String''. Optional. A Lua table or JSON string with additional http request-headers.
* '''postData''': ''Table / String''. Optional. When doing a <code>POST</code>, <code>PUT</code> 3.0.2 or <code>DELETE</code>3.0.2 this data will be the payload of the request (body). If you provide a Lua table then this will automatically be converted to json and the request-header <code>application/json</code> is set. So no need to do that manually. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': Raw response data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''headers''': ''Table''. Response headers.
* '''isJSON''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'application/json'</code>. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'text/xml'</code>. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be in range of 200-299.
* '''statusCode''': ''Number''. HTTP status codes. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''statusText''': ''String''. HTTP status message. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''protocol''': ''String''. HTTP protocol. See [https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP response status codes].
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


=== More about request and response headers ===

Whenever you do an http request it is not just some data that is sent. Along with the request a bunch of so-called headers are sent along with it. HTTP headers allow the client and the server to pass additional information with the request or the response. Also, in the response there are also headers (response header). These response headers usually tell you what kind of data is returned, if it is compressed, if the request was successful etc.


==== request headers ====

dzVents allow you to set custom request headers that will accompany the data in the request. Sometimes it is necessary to set these headers like for instance when a API or webservice require a security token or key or when the service needs to know what the format of the response data is. Check the documentation of the web service.

So, let’s say you need to call a web service that requires an api key in the headers and the documentation states it needs to be passed in an x-access-token header. Your openURL command then may look like this:

<syntaxhighlight lang="lua">domoticz.openURL({
url = 'https://somedomain.com/service/getInfo',
headers = { ['x-access-token'] = '<api-key>' },
method = 'GET',
callback = 'info'
})</syntaxhighlight>
Check google for more information about request headers. All you need to know here is that dzVents allow you to set these headers.


==== response headers ====

As said earlier, the response also contains a bunch of headers. You can inspect those headers with dzVents but ususally you don’t have to. For starters, dzVents already checks the <code>Content-Type</code> header which usually states what kind of data format the response is. If it is <code>application/json</code> then it automatically converts the json data to a Lua table. Also, it checks the <code>Status</code> header to see if the request was successful. If so, then it sets the <code>ok</code> attribute on the response object. So normally you don’t have to inspect the headers. However, sometimes the web service puts a session token in the response header that you have to use in follow-up requests.

So here an example where we have to log in before we can fetch data. It uses two requests: the first performs the log-in and the second grabs the session token from the login response data and uses that token in the second request to get the data we need. In this example we do this every hour.

That would look like this:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'loggedin', 'data' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/login',
method = 'POST',
postData = { ['username'] = 'Luke Skywalker', ['password'] = 'theforce' }
callback = 'loggedin'
})
end
if (item.isHTTPResponse and item.ok) then
-- check to which request this response was the result
if (item.trigger == 'loggedin') then
-- we are logged in, now grab the session token from the header and
-- fetch our data
local token = item.headers['x-session-token']
-- now we have the token, put it in the headers:
domoticz.openURL({
url = 'https://somedomain.com/getData',
method = 'GET',
headers = { ['x-session-token'] = token },
callback = 'data'
})
else
-- it must the data we requested
local data = item.data
-- do something with it
end
end
end
}</syntaxhighlight>
Some remarks about the response header <code>Content-Type</code>. If a service is a good web-citizen then it tells you what the format of the data is in this header. So, if the data is a json object then the header should be <code>application/json</code>. Unfortunately, there are lot of lazy programmers out there who don’t set this header properly. If that is the case, dzVents cannot detect the format and will not turn it into a Lua table for you automatically. So, if you know it is json but the header is not properly set, then you can easily convert it into a Lua table in your code:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/getData',
callback = 'trigger'
})
end
if (item.isHTTPResponse and item.ok) then
-- we know it is json but dzVents cannot detect this
-- convert to Lua
local json = domoticz.utils.fromJSON(item.data)
-- json is now a Lua table
print(json.result.title) -- just an example
end
end
}</syntaxhighlight>

= Asynchronous shell command execution =

dzVents allows you to make asynchronous shell commands and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use functions like <code>utils.osCommand()</code> or <code>os.Execute()</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz comes with a message that the script took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to execute a shell command asynchronously and it is determined by how you use the <code>domoticz.executeShellCommand()</code> command. The simplest form simply calls <code>executeShellCommand</code> on the domoticz object with only the command as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.executeShellCommand('some shell command')</syntaxhighlight>
After your script is finished, Domoticz will execute the request in a separate thread and that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a command you pass in a table with the command to be executed '''and''' a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.executeShellCommand({
command = 'some shell command',
callback = 'mycallbackstring',
timeout = timeoutinseconds,
})
end
}</syntaxhighlight>
In this case, Domoticz will execute the command and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
shellCommandResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if response.ok then
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every 5 minutes',
},
shellCommandResponses =
{
scriptVar,
},
},

execute = function(domoticz, item)
if item.isTimer then
domoticz.executeShellCommand(
{
command = 'some shell command',
callback = scriptVar,
timeout = timeoutinseconds,
})
elseif item.isShellCommandResponse then
if item.statusCode == 0 then
... -- process result (in item.json, -item.xml, -item.lines or item.data)
end
end
end
}
</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.executeShellCommand(options)''': ''options'' is a Lua table:

* '''command''': ''String''.
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to find a the callback handler script.
* '''timeout''': ''Integer''. Optional. Max execution time in seconds. defaults to 10 seconds. A value of 0 disables the timeout.

Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': output from the command. (stdout)
* '''errorText''': Errors generated by the command (stderr)
* '''statusCode''': ''Int''. exitcode generated by the command
* '''hasLines''': ''Boolean''. When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''json''': ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be 0.
* '''timeoutOccurred''' ''Boolean'' <code>True</code> when the request was aborted by a timeout.
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


= Settings =

Settings for dzVents are found in the Domoticz GUI: '''Setup > Settings > Other > EventSystem''':

* '''dzVents disabled''': Tick this if you don’t want any dzVents script to be executed.
* '''Log level''': (Note that you can override this setting in the logging section of your script)
** ''Errors'',
** ''Errors + minimal execution info'': Errors and some minimal information about which script is being executed and why,
** ''Errors + minimal execution info + generic info''. Even more information about script execution and a bit more log formatting.
** ''Debug''. Shows everything and dzVents will create the files <code>domoticzData.lua</code> and <code>module.log</code> in the scripts/dzVents folder. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz and <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.
** ''No logging''. As silent as possible.


= Troubleshooting =

So, you think if you have done everything correctly but things do not work (in some way) as you expected. Here are a couple steps you can do to find the cause.


=== Is dzVents enabled? ===

Check the settings (see above) and make sure the checkbox '''dzVents disabled''' is not checked.


=== Is your script enabled? ===

Make sure the active section in your script is set to <code>true</code>: <code>active = true</code>. And, on top of that, if you are using the internal web editor to write your script, make sure that your script is active there and you have clicked Save! “Event active” is a separate checkbox that must be ticked for every active script. When not active, the script name will be red in the list on the right.


=== Turn on debug logging ===

Activate debug logging in the settings (see above). This will produce a lot of extra messages in the Domoticz log (don’t forget to turn it off when you are done troubleshooting!). It is best to monitor the log through the command line, as the log in the browser sometimes tends to not always show all log messages. See the Domoticz manual for how to do that.

When debug logging is enabled, every time dzVents kicks into action (Domoticz throws an event) it will log it, and it will create the files <code>domoticzData.lua</code> and <code>module.log</code> in <code>/path/to/domoticz/scripts/dzVents</code>. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz. This data lie at the core of the dzVents object model. You can open this file in an editor to see if your device/variable/scene/group/hardware is in there. Note that the data in the file are not exactly the same as what you will get when you interact with dzVents, but it is a good start. If your object is not in the data file, then you will not have access to it in dzVents and dzVents will not be able to match triggers with that object. Something’s wrong if you expect your object to be in there but it is not (is the object active/used?). <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.with a dump of the data sent to dzVents.

Example content of <code>module.log</code>

<pre> Startdate time - End date time (clk - CPU ) dule / scriptname << type: "trigger"
---------------------------------------------------------------------------------------------------------------
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0029) waqi.lua << timer: "every 20 minutes"
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0016) Washer.lua << timer: "every 5 minutes"
11/27/20 18:40:01 - 11/27/20 18:40:01 (00 - 0.0215) getWaterFromHomewizard.lua << HTTPResponse: "WaterfromHomewizard"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.2472) updateWeatherSensors.lua << HTTPResponse: "WUS_buienradarResponse"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.0290) waqi.lua << HTTPResponse: "waqi_nearby"
11/27/20 18:41:00 - 11/27/20 18:41:00 (00 - 0.0583) Bathroom humidity.lua << timer: "every minute between 05:15 and 23:30"</pre>
Every time Domoticz starts dzVents and debug logging is enabled you should see these lines in the domoticz log:

<pre>dzVents version: x.y.z
Event trigger type: aaaa</pre>
Where aaaa can be time, custom event, system event, device, uservariable, security or scenegroup. That should give you a clue what kind of event is active. If you don’t see this information then dzVents is not active (or debug logging is not active).


=== Script is still not executed ===

If for some reason your script is not executed while all of the above is done, it is possible that your triggers are not correct. Either the time rule is not matching with the current time (try to set the rule to <code>every minute</code> or something simple), or the device name is not correct (check casing), or you use an id that doesn’t exist. Note that in the <code>on</code> section, you cannot use the dzVents domoticz object!

Make sure that if you use an id in the <code>on</code> section that this id is correct. Go to the device list in Domoticz and find the device and make sure the device is in the ‘used’ list!. Unused devices will not create an event. Find the idx for the device and use that as the id.

Also, make sure that your device names are unique! dzVents will throw a warning in the log if multiple device names match. It’s best practice to have unique names for your devices. Use some clever naming like prefixing like ‘Temperature: living room’ or ‘Lights: living room’. That also makes using wild cards on your <code>on</code> section easier.

If your script is still not triggered, you can try to create a classic Lua event script and see if that does work.


=== Debugging your script ===

A simple way to inspect a device in your script is to dump it to the log: <code>myDevice.dump()</code>. This will dump everything known to dzVents of the device so you can inspect what its state is. If you only need to see a subset you can use dumpSelection(‘attributes’), dumpSelection(‘functions’) or dumpSelection(‘tables’) Use print statements or domoticz.log() statements in your script at cricital locations to see if the Lua interpreter reaches that line. Don’t try to print a device object though; use the <code>myDevice.dump()</code> method for that. It wil log all attributes of the device in the Domoticz log.

If you place a print statement all the way at the top of your script file it will be printed every time dzVents loads your script (that is done at the beginning of each event cycle). Sometimes that is handy to see if your script gets loaded in the first place. If you don’t see your print statement in the log, then likely dzVents didn’t load it and it will not work.


=== Get help ===

The Domoticz forum is a great resource for help and solutions. Check the [https://www.domoticz.com/forum/viewforum.php?f=59 dzVents forum].


= Other interesting stuff =


== lodash for Lua ==

lodash is a well known and very popular Javascript library filled with dozens of handy helper functions that really make you life a lot easier. Fortunately there is also a Lua version. This is directly available through the domoticz object:

<syntaxhighlight lang="lua">local _ = domoticz.utils._
_.print(_.indexOf({2, 3, 'x', 4}, 'x'))</syntaxhighlight>

Check out the documentation [https://htmlpreview.github.io/?https://github.com/rwaaren/lodash.lua/blob/master/doc/index.html here].


= History [https://wiki.domoticz.com/DzVents_version_History link to changes in previous versions]. =

See link for the complete list of changes

https://wiki.domoticz.com/DzVents_version_History

DzVents: next generation Lua scripting

2026-08-02T17:03:39Z

Walter vl: /* Thermostat 6 3.1.11 */ layout

'''Note''': This document is maintained on [https://github.com/domoticz/domoticz/blob/development/dzVents/documentation/README.md github], and the wiki version is automatically generated. Edits should be performed on github, or they may be suggested on the wiki article’s [https://wiki.domoticz.com/Talk:DzVents:_next_generation_Lua_scripting Discussion page]. Editing can be done by any editor but if you are looking for a specialized markDown editor; [https://stackedit.io/app# stackedit.io] would be a good choice.


= About dzVents =

dzVents /diː ziː vɛnts/, short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts. And … '''it is 100% Lua'''! So if you already have a bunch of event scripts for Domoticz, upgrading should be fairly easy.

Let’s start with an example. Say you have a switch that when activated, it should activate another switch but only if the room temperature is above a certain level. And when done, it should send a notification. This is how it looks in dzVents:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'Room switch'}
},

execute = function(domoticz, roomSwitch)
if (roomSwitch.active and domoticz.devices('Living room').temperature > 18) then
domoticz.devices('Another switch').switchOn()
domoticz.notify('This rocks!',
'Turns out that it is getting warm here',
domoticz.PRIORITY_LOW)
end

}</syntaxhighlight>
Or you have a timer script that should be executed every 10 minutes, but only on weekdays, and have it do something with some user variables and only during daytime:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
--activate my scene
domoticz.scenes('Evening lights').switchOn()
if (domoticz.devices('My PIR').lastUpdate.minutesAgo > 5) then
domoticz.devices('Bathroom lights').switchOff()
end
end
end
}</syntaxhighlight>
Or you want to detect a humidity rise within the past 5 minutes:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'every 5 minutes'}
},
data =
{
previousHumidity = { initial = 100 }
},
execute = function(domoticz)
local bathroomSensor = domoticz.devices('BathroomSensor')
if (bathroomSensor.humidity - domoticz.data.previousHumidity) >= 5 then
-- there was a significant rise
domoticz.devices('Ventilator').switchOn()
end
-- store current value for next cycle
domoticz.data.previousHumidity = bathroomSensor.humidity
end
}</syntaxhighlight>
Just to give you an idea! Everything in your Domoticz system is now logically available in the domoticz object structure. With this domoticz object, you can get to all the information in your system and manipulate your devices.


= Using dzVents with Domoticz =

In Domoticz go to '''Setup > Settings > Other''' and in the section EventSystem make sure the check-box ‘dzVents disabled’ is not checked. Also make sure that in the Security section in the settings '''(Setup > Settings > System > Local Networks (no username/password)''' you allow 127.0.0.1 (and / or ::1 when using IPv6 ) to not need a password. dzVents does use this port to get the location settings and to send certain commands to Domoticz. Finally make sure you have set your current location in '''Setup > Settings > System > Location''', otherwise there is no way to determine nighttime/daytime state.

There are two ways of creating dzVents event scripts in Domoticz:

# By creating scripts in your domoticz instance on your domoticz server: <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Make sure that each script has the extension <code>.lua</code> and follows the guidelines as described below.
# By creating scripts inside Domoticz using the internal Domoticz event editor: Go to '''Setup > More Options > Events'''. Press the + button and choose dzVents. You must then choose a template. They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

'''Note: scripts that you write on the file-system and inside Domoticz using the internal web-editor all share the same name-space. That means that if you have two scripts with the same name, only the one of the file-system will be used. The log will tell you when this happens.'''

'''Note: Scripts created in the internal editor are stored in the domoticz database and are all written to <code>/path/to/domoticz/scripts/dzVents/generated_scripts</code> on every domoticz restart and every “EventSystem: reset all events…”. Scripts in <code>/path/to/domoticz/scripts/dzVents/scripts</code> are not stored in the database and should be backed-up separately. '''


== Quickstart ==

If you made sure that dzVents system is active, we can do a quick test if everything works:

* Pick a switch in your Domoticz system. Write down the exact name of the switch. If you don’t have a switch then you can create a Dummy switch and use that one.
* Create a new file in the <code>/path/to/domoticz/scripts/dzVents/scripts/</code> folder (or using the web-editor in Domoticz, switch to dzVents mode first.). Call the file <code>test.lua</code>. ''Note: when you create a script in the web-editor you do '''not''' add the .lua extension!'' Also, valid script names follow the same rules as [https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words filesystem names].
* Open <code>test.lua</code> in an editor and fill it with this code and change <code><exact name of the switch></code> with the .. you guessed it… exact name of the switch device:

<syntaxhighlight lang="lua"> return {
on = {
devices = {
'<exact name of the switch>'
}
},
execute = function(domoticz, switch)
if (switch.state == 'On') then
domoticz.log('Hey! I am on!')
else
domoticz.log('Hey! I am off!')
end
end
}</syntaxhighlight>
* Save the script
* Open the Domoticz log in the browser
* In Domoticz GUI perhaps in another browser tab) press the switch.
* You can watch the log in Domoticz and it should show you that indeed it triggered your script and you should see the log messages.

See the examples folder <code>/path/to/domoticz/scripts/dzVents/examples</code> for more examples. This folder includes templates you can use to get started as well. And, if you use the GUI web editor to write your script, you will find boilerplate examples in the drop-down below the script type setting.


= Writing scripts =

In order for your scripts to work with dzVents, they have to be turned into a Lua module with a specific structure. Basically you make sure it returns a Lua table (object) with predefined keys like <code>on</code> and <code>execute</code>. Here is an example:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'My switch' }
},

execute = function(domoticz, switch)
-- your script logic goes here, something like this:
if (switch.state == 'On') then
domoticz.log('I am on!', domoticz.LOG_INFO)
end
end
}</syntaxhighlight>
Simply said, the <code>on</code>-part defines the trigger and the <code>execute</code> part is what should be done if the trigger matches with the current Domoticz event. So all your logic is inside the <code>execute</code> function.


== Sections in the script ==

Each dzVents event script has this structure:

<syntaxhighlight lang="lua">return
{
active = true, -- optional
on =
{
-- at least one of these:
customEvents = { ... },
devices = { ... },
groups = { ... },
httpResponses = { ... },
scenes = { ... },
security = { ... },
shellCommandResponses = { ... },
system = { ... },
timer = { ... },
variables = { ... },

},
data = { ... }, -- optional
logging = { ... }, -- optional
execute = function(domoticz, item, triggerInfo)
-- your code here
end
}</syntaxhighlight>

=== active = true/false (optional) ===

If <code>active = false</code>, then the script is not activated: ''dzVents will ignore the script completely''. If you don’t have <code>active</code> specified, <code>true</code> is assumed (default value). If you write scripts with Domoticz’ internal script editor then you don’t need this part as the editor has its own way of enabling and disabling scripts.

So, <code>active</code> can either be:

* '''true''': (default) the script file will be processed.
* '''false''': the script file is ignored.
* '''function(domoticz) … end''': A function returning <code>true</code> or <code>false</code>. The function will receive the domoticz object with all the information about your domoticz instance: <code>active = function(domoticz) .... end</code>. For example you could check for a Domoticz variable or switch and prevent the script from being executed. '''However, be aware that for ''every script'' in your scripts folder, this active function will be called, every cycle!! Therefore, it is better to put all your logic in the execute function instead of in the active function.'''


=== on = { … } ===

The <code>on</code> section tells dzVents ''when'' the execute function has to be executed. It holds all the events/'''triggers''' that are monitored by dzVents. If any of the events or triggers match with the current event coming from Domoticz, then the <code>execute</code> part of the script is executed by dzVents. The <code>on</code> section has many kinds of subsections that ''can all be used simultaneously'' :


==== customEvents = { … } 3.0.0 ====

A list of one or more custom event triggers. This eventTrigger can be activate by a json/api call, a MQTT message (when domoticz is setup to listen to such messages on the hardware tab) or by the dzVents internal command domoticz.emitEvent - The name of the custom-event - The name of the custom-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|See time trigger rules]].


===== API =====

<pre>- curl: curl -d "{ 'a':10, 'b':20, 'some':'text', 'sub' : { 'x':10, 'y':20 } }" "http://<domoticzIP:domoticz port>/json.htm?type=command&param=customevent&event=<myCustomEvent>"
- JSON: **< domoticzIP : domoticz port >**/json.htm?type=command&param=customevent&event=<MyEvent>&data=myData
- MQTT simple: {"command":"customevent", "event":"MyEvent","data":"myData"}
- MQTT complex: {"command":"customevent","event":"MyEvent","data":"{\"idx\":29,\"test\":\"ok\"}" }
- emitEvent: domoticz.emitEvent('myCustomEvent' [,])
`domoticz.emitEvent('myEvent') -- no data`
`domoticz.emitEvent('another event', 'some data')`
`domoticz.emitEvent('hugeEvent', { a = 10, b = 20, some = 'text', sub = { x = 10, y = 20 } })`</pre>

===== Attributes =====

The customEvent object (second parameter in your execute function) has these attributes:

* '''data''': Raw customEvent data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''.3.0.3 true when the customEvent data is a valid json string. The data is then automatically converted to a Lua table.
* '''isXML''': ''Boolean''. 3.0.3 true when the customEvent data is a valid xml string. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. 3.0.3 When the customEvent data is a valid json string, the response data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a table for quick and easy access. nil otherwise
* '''trigger''', '''customEvent''': ''String''.3.0.3 The string that triggered this customEvent instance. This is useful if you have a script that can be triggered by multiple different customEvent strings.
* '''xml'''. ''Table''. 3.0.3 When the response data is a valid xml string, the customEvent data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


==== devices = { … } ====

A list of device-names or indexes. If a device in your system was updated (e.g. a switch was triggered or a new temperature was received) and it is listed in this section then the execute function is executed. '''Note''': update does not necessarily means the device state or value has changed. Each device can be:

* The name of your device between string quotes. '''You can use the asterisk (*) wild-card here e.g. <code>PIR_*</code> or <code>*_PIR</code>'''. E.g.: <code>devices = { 'myDevice', 'anotherDevice', 123, 'pir*' }</code>
* The index (idx) of your device (as the name may change, the index will usually stay the same, the index can be found in the devices section in Domoticz). '''Note that idx is a number;'''
* The name or idx of your device followed by a time constraint, such as: <code>['myDevice'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if <code>myDevice</code> was changed, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].


==== groups = { …} ====

A list of one or more group-names or indexes. The same rules as devices apply.


==== httpResponses = { …} ====

A list of one or more http callback triggers. Use this in conjunction with <code>domoticz.openURL()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


==== shellCommandResponses = { …} 3.1.0 ====

A list of one or more scriptcommand callback triggers. Use this in conjunction with <code>domoticz.executeShellCommand()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.


==== scenes = { … } ====

A list of one or more scene-names or indexes. The same rules as devices apply. So if your scene is listed in this table then the executed function will be triggered, e.g.: <code>on = { scenes = { 'myScene', 'anotherScene' } },</code>.


==== security = { … } ====

A list of one or more of these security states:

* <code>domoticz.SECURITY_ARMEDAWAY</code>,
* <code>domoticz.SECURITY_ARMEDHOME</code>,
* <code>domoticz.SECURITY_DISARMED</code>

If the security state in Domoticz changes and it matches with any of the states listed here, the script will be executed. See <code>/path/to/domoticz/scripts/dzVents/examples/templates/security.lua</code> for an example see [[#Security_Panel|Security Panel]] for information about how to create a security panel device.


==== system = { …} 3.0.0 ====

A list of one or more system triggers.

* <code>stop</code>, <code>start</code>, <code>manualBackupFinished</code>, <code>dailyBackupFinished</code>, <code>hourlyBackupFinished</code>, <code>monthlyBackupFinished</code>, <code>resetAllDeviceStatus</code>, 3.1.5 <code>resetAllEvents</code>, 3.1.5
* The name of the system-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].
** '''start''' - fired when Domoticz has started.
** '''stop''' - fired when Domoticz is shutting down. As you probably can imagine you have only a limited amount of time - also depending on the load on your system - to have Domoticz do stuff when your script has been completed. Some commands will probably not be executed. Just give it a try.
** '''Backups''' - the trigger item (2nd parameter of the execute function) is a table that holds information about the newly created backup (location, duration in seconds and type). You could use this information to copy the file to some other location or for another purpose.
*** '''dailyBackupFinished''' - automatic backup when set in domoticz
*** '''hourlyBackupFinished''' - ” ”
*** '''monthlyBackupFinished''' - ” ”
*** '''manualBackupFinished''' - fired when you start a backup using the Domoticz GUI or via '''< domoticz IP:domoticz port >'''/backupdatabase.php
*** '''resetAllDeviceStatus''' 3.1.5- fired when the name, description or used / unused state of a device, variable or scene is updated.
*** '''resetAllEvents''' 3.1.5- fired when a dzVents script in the internal editor changed.


==== timer = { … } ====

A list of one ore more time ‘rules’ like <code>every minute</code> or <code>at 17:*</code>. See [[#timer_trigger_rules|''timer'' trigger rules]]. If any or the rules matches with the current time/date then your execute function is called. E.g.: <code>on = { timer = { 'between 30 minutes before sunset and 30 minutes after sunrise' } }</code>.


==== variables = { … } ====

A list of one or more user variable-names as defined in Domoticz ( ''Setup > More options > User variables''). If any of the variables listed here is updated, ( '''Note''': update does not necessarily means the variable value or type changed ).the script is executed. '''Note''': Script will only execute when this variable is updated directly by dzVents or by a JSON. If updated with a standard Lua script (using commandArray) or in combination with a time option like afterAAA no event will be triggered.


=== execute = function('''domoticz, item, triggerInfo''') … end ===

When all the above conditions are met (active == true and the on section has at least one matching rule), then this <code>execute</code> function is called. This is the heart of your script. The function has three parameters:


==== 1. ('''domoticz''', item, triggerInfo) ====

The [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]]. This object gives you access to almost everything in your Domoticz system, including all methods to manipulate them—like modifying switches or sending notifications. More about the [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]] below.


==== 2. (domoticz, '''item''', triggerInfo) ====

Depending on what actually triggered the script, <code>item</code> is either a:

* [[#Custom_event_API|customEvent]] 3.0.0
* [[#Device_object_API|device]],
* [[#Variable_object_API_.28user_variables.29|variable]],
* [[#Scene|scene]],
* [[#Group|group]],
* [[#timer_=_%7B_..._%7D|timer]],
* [[#System_event_API|system]], 3.0.0
* [[#Security_Panel|security]] or
* [[#Asynchronous_HTTP_requests|httpResponse]]
* [[#Asynchronous_shell_command_executio|shellCommandResponse]] 3.1.0

Since you can define multiple on-triggers in your script, it is not always clear what the type is of this second parameter. In your code you need to know this in order to properly respond to the different events. To help you inspect the object you can use these attributes like <code>if (item.isDevice) then ... end</code>:

* '''isCustomEvent''': 3.0.0. returns <code>true</code> if the item is a customEvent object.
* '''isDevice''': . returns <code>true</code> if the item is a Device object.
* '''isGroup''': . returns <code>true</code> if the item is a Group object.
* '''isHTTPResponse''': . returns <code>true</code> if the item is an HTTPResponse object.
* '''isShellCommandResponse''': . 3.1.0 returns <code>true</code> if the item is a shellcommandResponse object.
* '''isScene''': . returns <code>true</code> if the item is a Scene object.
* '''isSecurity''': . returns <code>true</code> if the item is a Security object.
* '''isSystemEvent''': 3.0.0. returns <code>true</code> if the item is a system object.
* '''isTimer''': . returns <code>true</code> if the item is a Timer object.
* '''isVariable''': . returns <code>true</code> if the item is a Variable object.
* '''trigger''': . ''string''. the timer rule, the security state, the customEvent or the http response callback string that actually triggered your script. E.g. if you have multiple timer rules can inspect <code>trigger</code> which exact timer rule was fired.


==== 3. (domoticz, item, '''triggerInfo''') ====

'''Note''': as of version 2.4.0, <code>triggerInfo</code> has become more or less obsolete and is left in here for backward compatibility. All information is now available on the <code>item</code> parameter (second parameter of the execute function, see point 2 above).

<code>triggerInfo</code> holds information about what triggered the script. The object has two attributes:

# '''type''': the type of the the event that triggered the execute function, either: - domoticz.EVENT_TYPE_CUSTOM,3.0.0 - domoticz.EVENT_TYPE_DEVICE, - domoticz.EVENT_TYPE_GROUP - domoticz.EVENT_TYPE_HTTPRESPONSE - domoticz.EVENT_TYPE_SCENE, - domoticz.EVENT_TYPE_SECURITY, - domoticz.EVENT_TYPE_SYSTEM,3.0.0 - domoticz.EVENT_TYPE_TIMER, - domoticz.EVENT_TYPE_VARIABLE)
# '''trigger''': the timer rule that triggered the script if the script was called due to a timer event, or the security state that triggered the security trigger rule. See [[#timer_trigger_rules|below]] for the possible timer trigger rules.
# '''scriptName''': the name of the current script.


==== Tip: rename the parameters to better fit your needs ====

The names of the execute parameters are actually something you can change to your convenience. For instance, if you only have one trigger for a specific switch device, you can rename <code>item</code> it to <code>switch</code>. Or if you think <code>domoticz</code> is too long you can rename it to <code>d</code> or <code>dz</code> (might save you a lot of typing and may make your code more readable):

<syntaxhighlight lang="lua">return
{
on =
{
devices = 'mySwitch'
},
execute = function(dz, mySwitch)
dz.log(mySwitch.state, dz.LOG_INFO)
end
}</syntaxhighlight>

=== data = { … } (optional) ===

The optional data section allows you to define local variables that will hold their values ''between'' script runs. These variables can get a value in your execute function and the next time the script is executed these variables will have their previous state restored. For more information see the section [[#Persistent_data|Persistent data]].


=== logging = { … } (optional) ===

The optional logging section allows you to override the global logging setting of dzVents as set in ''Setup > Settings > Other > EventSystem > dzVents Log Level''. This can be handy when you only want this script to have extensive debug logging while the rest of your script executes silently. You have these options:

* '''level''': This is the minimum log level you want for this script. This can be domoticz.LOG_INFO, domoticz.LOG_STATUS, domoticz.LOG_ERROR or domoticz.LOG_DEBUG
* '''marker''': A string that is prefixed before each log message. That way you can easily create a filter in the Domoticz log to see just these messages. '''marker''' defaults to scriptname

\*LOG_DEBUG will also cause Execution Info to be displayed (start/finished)

Example:

<syntaxhighlight lang="lua">logging = {
level = domoticz.LOG_DEBUG,
marker = "Hey you"
},</syntaxhighlight>

== Some trigger examples ==


=== Custom events ===

Suppose you want to trigger a script not on the minute but 30 seconds later.

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every minute',
},

customEvents =
{
'delayed',
},
},
execute = function(domoticz, item)
if item.isTimer then
domoticz.emitEvent('delayed', domoticz.time.rawTime ).afterSec(30)
else
domoticz.notify('Delayed', 'Event was emitted at ' .. item.data, domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Device changes ===

Suppose you have two devices—a smoke detector ‘myDetector’ and a room temperature sensor ‘roomTemp’, and you want to send a notification when either the detector detects smoke or the temperature is too high:

<syntaxhighlight lang="lua">return
{
on =
{
devices = {
'myDetector',
'roomTemp'
}
},
execute = function(domoticz, device)
if ((device.name == 'myDetector' and device.active) or
(device.name == 'roomTemp' and device.temperature >= 45)) then
domoticz.notify('Fire', 'The room is on fire', domoticz.PRIORITY_EMERGENCY)
end
end
}</syntaxhighlight>

=== Scene / group changes ===

Suppose you have a scene ‘myScene’ and a group ‘myGroup’, and you want to turn on the group as soon as myScene is activated:

<syntaxhighlight lang="lua">return {
on = {
scenes = { 'myScene' }
},
execute = function(domoticz, scene)
if (scene.state == 'On') then
domoticz.groups('myGroup').switchOn()
end
end
}</syntaxhighlight>
Or, if you want to send an email when a group is activated at night:

<syntaxhighlight lang="lua">return {
on = {
groups = { ['myGroup'] = {'at nighttime'} }
},
execute = function(domoticz, group)
if (group.state == 'On') then
domoticz.email('Hey', 'The group is on', 'someone@the.world.org')
end
end
}</syntaxhighlight>

=== Timer events ===

Suppose you want to check the soil humidity every 30 minutes during the day and every hour during the night:

<syntaxhighlight lang="lua">return {
on = {
timer = {
'every 30 minutes at daytime',
'every 60 minutes at nighttime'
}
},
execute = function(domoticz, timer)
domoticz.log('The rule that triggered the event was: ' .. timer.trigger')
if (domoticz.devices('soil').moisture > 100) then
domoticz.devices('irrigation').switchOn().forMin(60)
end
end
}</syntaxhighlight>

=== Variable changes ===

Suppose you have a script that updates a variable ‘myAmountOfMoney’, and if that variable reaches a certain level you want to be notified:

<syntaxhighlight lang="lua">return
{
on =
{
variables = { 'myAmountOfMoney' }
},
execute = function(domoticz, variable)
-- variable is the variable that's triggered
if (variable.value > 1000000) then
domoticz.notify('Rich', 'You can stop working now', domoticz.PRIORITY_HIGH)
end
end
}</syntaxhighlight>

=== Security changes ===

Suppose you have a group holding all the lights in your house, and you want to switch it off as soon as the alarm is activated:

<syntaxhighlight lang="lua">return
{
on =
{
security = { domoticz.SECURITY_ARMEDAWAY }
},
execute = function(domoticz, security)
domoticz.groups('All lights').switchOff()
end
}</syntaxhighlight>

=== Asynchronous HTTP Request and handling ===

Suppose you have some external web service that will tell you what the current energy consumption is and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
httpResponses = { 'energyRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = 'http://url/to/service',
method = 'GET',
callback = 'energyRetrieved'
})
elseif (item.isHTTPResponse) then
if (item.ok) then -- statusCode == 2xx
local current = item.json.consumption
domoticz.devices('myCurrentUsage').updateEnergy(current)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


=== Asynchronous shell command execution 3.1.0 ===

Suppose you have some local shellcommand to measure the speed of your internet connection and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
shellCommandResponses = { 'internetspeedRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.executeShellCommand({
command = 'speedtest-cli --json', -- just an example
callback = 'internetspeedRetrieved', -- see shellCommandResponses above.
timeout = 20, -- max execution time in seconds
})
elseif (item.isShellCommandResponse) then
if (item.statusCode==0) then
domoticz.devices('myCurrentdownloadspeed').updateCustomSensor(item.json.download)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_shell_command_execution|asynchronous shell commands]] for more information.


=== System changes ===

Do some initial work when domoticz starts

<syntaxhighlight lang="lua">return
{
on =
{
system =
{
'start',
'backupDoneDaily',
},

},

execute = function(domoticz, system)
domoticz.log('Domoticz sends ' .. system.type, domoticz.LOG_INFO)

if system.type == 'start' then
domoticz.device('initial device').switchOff().silent
domoticz.variables('special startVar').set('domoticz started at ' .. domoticz.time.rawDateTime )
elseif system.type == 'backupDoneDaily' then
domoticz.notify('Domoticz backup', 'Ended. Backupfile ' .. system.data.location , domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Combined rules ===

Let’s say you have a script that checks the status of a lamp and is triggered by motion detector:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
devices = { 'myDetector' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- the timer was triggered
domoticz.devices('myLamp').switchOff()
elseif (item.isDevice and item.active) then
-- it must be the detector
domoticz.devices('myLamp').switchOn()
end
end
}</syntaxhighlight>

=== At startup trigger ===

You can add <code>at_startup = true</code> to the <code>on</code> section to have your script execute once when Domoticz starts, in addition to any other triggers. This is useful when combined with interval-based rules to avoid waiting for the first interval to pass:

<syntaxhighlight lang="lua">return {
on = {
at_startup = true,
timer = { 'every hour' },
},
execute = function(domoticz, item)
-- Runs immediately when Domoticz starts, then every hour
domoticz.devices('myThermostat').setPoint(21)
end
}</syntaxhighlight>
The <code>at_startup</code> trigger fires on the first timer tick after Domoticz starts (within 2 minutes of startup). It can be combined with any other trigger types (timer, devices, httpResponses, etc.).

'''Note:''' This is different from <code>system = { 'start' }</code> which is a system event trigger. <code>at_startup</code> is simpler - just add the flag and your existing script will also run at startup without needing to check <code>item.isSystemEvent</code>.


== ''timer'' trigger rules ==

There are several options for time triggers. It is important to know that Domoticz timer events only trigger once every minute, so one minute is the smallest interval for your timer scripts. However, dzVents gives you many options to have full control over when and how often your timer scripts are called (all times are in 24hr format and all dates in dd/mm): Keywords recognized are “at, between, every, except, in, on, or” ( except supported from version 3.0.16, or supported from version 3.1.8 ).

At every place you read <astroMoment> you can use one of: sunset, sunrise, solarnoon, midnight '', sunatsouth '', civiltwilightstart, civiltwilightend, astronomicaltwilightstart '', astronomicaltwilightend '', nauticaltwilightstart * or nauticaltwilightend *.

Full daynames are allowed in dzVents >= 3.1.7

* 3.1.16

<syntaxhighlight lang="lua"> on = {
timer = {
'every minute', -- causes the script to be called every minute
'every other minute', -- minutes: xx:00, xx:02, xx:04, ..., xx:58
'every <xx> minutes', -- starting from xx:00 triggers every xx minutes
-- (0 > xx < 60)
'every hour', -- 00:00, 01:00, ..., 23:00 (24x per 24hrs)
'every other hour', -- 00:00, 02:00, ..., 22:00 (12x per 24hrs)
'every <xx> hours', -- starting from 00:00, triggers every xx
-- hours (0 > xx < 24)
'at 13:45', -- specific time
'at *:45', -- every 45th minute in the hour
'at 15:*', -- every minute between 15:00 and 16:00
'at 12:45-21:15', -- between 12:45 and 21:15. You cannot use '*'!
'at 19:30-08:20', -- between 19:30 and 8:20 (next day)
'at 13:45 on mon,tue', -- at 13:45 only on Mondays and Tuesdays (english)
'on mon,tue', -- on Mondays and Tuesdays
'every hour on Saturday', -- you guessed it correctly
'at sunset', -- uses sunset/sunrise/solarnoon info from Domoticz
'at sunrise',
'at <astroMoment>', -- dzVents >= 3.0.16 Uses the times received from Domoticz
'at <astroMoment> on sat,sun',
'xx minutes before <astroMoment>', --
'xx minutes after <astroMoment>', -- Please note that these relative times will cross dates
'between aa and bb' -- aa/bb can be a time stamp like 15:44 (if aa > bb will cross dates)
-- aa/bb can be sunrise/sunset/solarnoon ('between sunset and sunrise' and 'between solarnoon and sunrise' will cross dates)
-- aa/bb can be 'xx minutes before/after <astroMoment>'
'at <astroRange>', -- between <astroMoment>start and <astroMoment>end
'at nighttime', -- between sunset and sunrise
'at daytime', -- between sunrise and sunset
'at daytime on mon,tue', -- between sunrise and sunset only on Mondays and Tuesdays
'in week 1-7,44' -- in week 1-7 or 44
'in week 20-25,33-47' -- between week 20 and 25 or week 33 and 47
'in week -12, 33-' -- week <= 12 or week >= 33
'every odd week',
'every even week', -- odd or even numbered weeks
'on 23/11', -- on 23rd of November (dd/mm)
'on 23/11-25/12', -- between 23/11 and 25/12
'on 2/3-8/3,7/8,6/10-14/10',-- between march 2 and 8, on august 7 and between October 6 and 14.
'on */2,15/*', -- every day in February or
-- every 15th day of the month
'on -3/4,4/7-', -- before 3/4 or after 4/7

'at 12:45-21:15 except at 18:00-18:30', -- between 12:45 and 21:15 but not between 18:00 and 18:30 ( except supported from 3.0.16 onwards )
'at daytime except on sun', -- between sunrise and sunset but not on Sundays
'at daytime or at 23:12', -- between sunrise and sunset and also at 23:12

-- or if you want to go really wild and combine them:
'at nighttime at 21:32-05:44 every 5 minutes on sat, sun except at 04:00', -- except supported from 3.0.16 onwards
'every 10 minutes between 20 minutes before sunset and 30 minutes after sunrise on mon,fri,tue on 20/5-18/8'

-- or just do it yourself:
function(domoticz)
-- you can use domoticz.time to get the current time
-- note that this function is called every minute!
-- custom code that either returns true or false
...
end
},
}</syntaxhighlight>
The timer events are triggered every minute. If such a trigger occurs, dzVents will scan all timer-based events and will evaluate the timer rules. So, if you have a rule <code>on mon</code> then the script will be executed ''every minute'' but only on Monday.

Be mindful of the logic if using multiple types of timer triggers. It may not make sense to combine a trigger for a specific or instantaneous time with a trigger for a span or sequence of times (like ‘at sunset’ with ‘every 6 minutes’) in the same construct. Similarly, <code>'between aa and bb'</code> only makes sense with instantaneous times for <code>aa</code> and <code>bb</code>.

'''One important note: if Domoticz, for whatever reason, skips a timer event then you may miss the trigger! Therefore, you should build in some fail-safe checks or some redundancy if you have critical time-based stuff to control. There is nothing dzVents can do about it'''

'''Tip:''' If you want your timer script to also run at Domoticz startup (instead of waiting for the first timer match), add <code>at_startup = true</code> to your <code>on</code> section. See [[#at-startup-trigger|At startup trigger]].

Another important issue: the way it is implemented right now, the <code>every xx minutes</code> and <code>every xx hours</code> is a bit limited. The interval resets at every *:00 (for minutes) or 00:* for hours. You need an interval that is an integer divider of 60 (or 24 for the hours). So you can do every 1, 2, 3, 4, 5, 6, 10, 12, 15, 20 and 30 minutes only.


= The domoticz object =

The domoticz object passed as the first parameter to the <code>execute</code> function contains everything you need to interact with your domotica system. It provides all information made available by the domoticz event system about your custom- and system events, devices, scenes, groups, hardware modules and variables and has methods needed to inspect and manipulate them. Getting this information is easy:

<code>domoticz.time.isDayTime</code> or <code>domoticz.devices('My sensor').temperature</code> or <code>domoticz.devices('My sensor').lastUpdate.minutesAgo</code>.

The domoticz object consists of a logically arranges structure. It harbors all methods to manipulate Domoticz. dzVents will take care to notify Domoticz with all your intended changes and actions. Earlier you had to fill a commandArray with obscure commands. That’s no longer the case.

Some more examples: <code>domoticz.devices(123).switchOn().forMin(5).afterSec(10)</code> or <code>domoticz.devices('My dummy sensor').updateBarometer(1034, domoticz.BARO_THUNDERSTORM)</code>.

One tip before you get started: '''Make sure that all your devices have unique names. dzVents will give you warnings in the logs if device names are not unique.'''


== Domoticz object API (Application Programming Interface) ==

The domoticz object holds all information about your Domoticz system. It has global attributes and methods to query and manipulate your system. It also has a collection of '''devices''', '''variables''' (user variables in Domoticz), '''scenes''', '''groups''', '''hardware'''. Each of these collections has four iterator functions: <code>find(), forEach()</code>, <code>filter()</code> and <code>reduce()</code> to make searching for devices easier. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]].


=== Domoticz attributes and methods ===

* '''devices(idx/name)''': ''Function''. A function returning a device by idx or name: <code>domoticz.devices(123)</code> or <code>domoticz.devices('My switch')</code>. For the device API see [[#Device_object_API|Device object API]]. To iterate over all devices do: <code>domoticz.devices().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.devices()) do .. end</code>.
* '''dump([osfile]3.0.0)''': ''Function''. Dump all domoticz.settings attributes to the Domoticz log. This ignores the log level setting.
* '''email(subject, message, mailTo [, delay]3.0.10)''': ''Function''. Send email. Optional parm delay is delay in seconds.
* '''emitEvent(name,[extra data ])''':''Function''. 3.0.0 Have Domoticz ‘call’ a customEvent. If you just pass a name then Domoticz will execute the script(s) that subscribed to the named customEvent after your script has finished. You can optionally pass extra information as a string or table. A table will be automatically converted into a json string and converted back to a table in the subscribed script(s). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''executeShellCommand(command/options)''': ''Function''. 3.1.0 Have Domoticz ‘call’ a command. If you just pass a command then Domoticz will execute the command after your script has finished but you will not get notified. If you pass options table with a callback then you have the possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_shell_command_execution|asynchronous shell commands]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. '''Note Make sure that when you use this function on a Windows system and use one or more of the special chars &<>()@^| outside double quotes, you will have to escape these with a ^ char '''
* '''groups(idx/name)''': ''Function'': A function returning a group by name or idx. Each group has the same interface as a device. To iterate over all groups do: <code>domoticz.groups().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.groups()) do .. end</code>. Read more about [[#Group|Groups]].
* '''hardwareInfo(idx/name)''': 3.0.6 ''Function'': A function returning hardwareInfo of a hardware module by name or idx. The return of the function is a table with attributes name, type, typeValue, deviceNames (table with names of all active devices defined on this hardware) and deviceIds (table with idx of all active devices defined on this hardware)
* '''hardware(idx/name)''': 3.0.7 ''Function'': A function returning a hardware module by name or idx. Each hardware has an interface comparable to group. To iterate over all hardware do: <code>domoticz.hardware().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.hardware()) do .. end</code>. Read more about [[#Hardware|Hardware]].
* '''helpers''': ''Table''. Collection of shared helper functions available to all your dzVents scripts. See [[#Shared_helper_functions|Shared helper functions]].
* '''log(message, [level])''': ''Function''. Creates a log entry in the Domoticz log but respects the log minimum level settings. You can provide the loglevel: <code>domoticz.LOG_INFO</code>, <code>domoticz.LOG_STATUS</code>, <code>domoticz.LOG_ERROR</code>, <code>domoticz.LOG_DEBUG</code> or <code>domoticz.LOG_FORCE</code>. In Domoticz settings you can set the default log level for dzVents.
* '''moduleLabel''': 3.0.3 Module (script) name without extension.
* '''notify(subject, message [,priority][,sound][,extra][,subsystem][,delay]3.0.10 )''': ''Function''. Send a notification (like Prowl). Priority can be like <code>domoticz.PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY</code>. <code>extra</code> is notification subsystem specific. For NSS_FIREBASE you can use this field to specify the target mobile (‘midx_1’, midx_2, etc..) or specify <code>device.id</code> so the receiver knows which device triggered the notification. For sound see [[#Constants|list of dzVents Constants]] for the SOUND constants below. <code>subsystem</code> defaults to all subsystems but can be one subsystem or a table containing one or more notification subsystems. See [[#Constants|list of dzVents Constants]] for <code>domoticz.NSS_subsystem</code> types. Delay is delay in seconds
* '''openURL(url/options)''': ''Function''. Have Domoticz ‘call’ a URL. If you just pass a url then Domoticz will execute the url after your script has finished but you will not get notified. If you pass a table with options then you have to possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_HTTP_requests|asynchronous http requests]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''scenes(idx/name)''': ''Function'': A function returning a scene by name or id. Each scene has the same interface as a device. See [[#Device_object_API|Device object API]]. To iterate over all scenes do: <code>domoticz.scenes().forEach(..)</code>. See [[#looping-through-the-collections-iterators|Looping through the collections: iterators]]. (#Looping_through_the_collections:_iterators). Note that you cannot do <code>for i, j in pairs(domoticz.scenes()) do .. end</code>. Read more about [[#Scene|Scenes]].
* '''security''': Holds the state of the security system e.g. <code>Armed Home</code> or <code>Armed Away</code>.
* '''sendCommand(command, value[, delay] 3.0.10)''': Generic (low-level)command method (adds it to the commandArray) to the list of commands that are being sent back to domoticz. Optional parm delay is delay in seconds ''There is likely no need to use this directly. Use any of the device methods instead (see below).''
* '''settings''':
** '''domoticzVersion''': domoticz version string.
** '''dzVentsVersion''': dzVents version string.
** '''location'''
*** '''latitude''': domoticz settings locations latitude.
*** '''longitude''': domoticz settings locations longitude.
*** '''name''': domoticz settings location Name.
** '''secureServer''': ''boolean'' 3.1.1 true when domoticz can be accessed via https.
** '''serverPort''': webserver listening port used by dzVents to access domoticz API.
** '''url''': internal url to access the API service.
** '''webRoot''': <code>webroot</code> 3.1.1 value as specified when starting the Domoticz service (or default).
** '''wwwBind''': <code>wwwbind</code> 3.1.4 value as specified when starting the Domoticz service (or default).
* '''sms(message [, delay] 3.0.10 )''': ''Function''. Sends an sms if it is configured in Domoticz. Optional parm delay is delay in seconds.
* '''snapshot(cameraID(s) or camera Name(s)3.0.13,subject)''': ''Function''. Sends email with a camera snapshots if email is configured and set for attachments in Domoticz. Send 1 or multiple camerIDs -names in ; separated string or array.

<syntaxhighlight lang="lua"> dz.snapshot() -- defaults to id = 1, subject domoticz
dz.snapshot(1,'dz') -- subject dz
dz.snapshot('1;2;3') -- ; separated string
dz.snapshot({1,4,7}) -- table
dz.snapshot('test;test2') -- ; separated string
dz.snapshot({'test', 'test2'}) -- table</syntaxhighlight>
<ul>
<li>'''switchTimerPlan(idx)''': ''Function''. Switch the active timer plan to the plan with the given database ID. <code>idx</code> must be a positive integer matching an existing timer plan ID (as shown in '''Settings → Timer Plans'''). Invalid or non-existent plan IDs are silently ignored. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''startTime''': ''[[#Time_object|Time Object]]''. Returns the startup time of the Domoticz service.</li>
<li>'''systemUptime''': ''Number''. Number of seconds the system is up.</li>
<li>'''time''': ''[[#Time_object|Time Object]]'': Current system time. Additional to Time object attributes:
<ul>
<li>'''isDayTime''': ''Boolean''</li>
<li>'''isNightTime''': ''Boolean''</li>
<li>'''isCivilDayTime''': ''Boolean''.</li>
<li>'''isCivilNightTime''': ''Boolean''.</li>
<li>'''isToday''': ''Boolean''. Indicates if the device was updated today</li>
<li>'''sunriseInMinutes''': ''Number''. Number of minutes since midnight when the sun will rise.</li>
<li>'''sunsetInMinutes''': ''Number''. Number of minutes since midnight when the sun will set.</li>
<li>'''civTwilightStartInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will start.</li>
<li>'''civTwilightEndInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will end.</li></ul></li>
<li>'''triggerHTTPResponse([httpResponse], [delay], [message])''': ''Function''. Creates a callback by sending a logmessage. httpResponse defaults to scriptname, delay defaults to 0 (immediate), message defaults to httpResponse. Left in for backward compatibility only. You can use emitEvent / customEvents now.</li>
<li>'''triggerIFTTT(makerName [,sValue1, sValue2, sValue3])''': ''Function''. Have Domoticz ‘call’ an IFTTT maker event. makerName is required, 0-3 sValue’s are optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''utils''': . A subset of handy utilities: Note that these functions must be preceded by domoticz.utils. If you use more then a few declare something like local _u = domoticz.utils at the beginning of your script and use _u.functionName in the remainder. Example:
<syntaxhighlight lang="lua"> _u = domoticz.utils
print(_u.rightPad('test',10) .. '|||') -- => test |||</syntaxhighlight>
<ul>
<li>'''_.lodashFunctions''': This is an entire collection with very handy Luafunctions. Read more about [[#lodash_for_Lua|lodash]]. E.g.: <code>{.lua} domoticz.utils._.size({'abc', 'def'}))` Returns 2.</code></li>
<li>'''cameraExists(parm)''': ''Function'': returns name when entered with a valid camera 3.0.12 or cameraID and return ID when entered with valid cameraName or false when not a camera, cameraID or cameraName of an existing camera</li>
<li>'''deviceExists(parm)''': ''Function'': returns name when entered with a valid device 3.0.12 or deviceID and returns ID when entered with valid deviceName or false when not a device, deviceID or deviceName of an existing (and active) device. Example:
<syntaxhighlight lang="lua">local dz = domoticz
local _u = dz.utils
if _u.deviceExists('myDevice') then
dz.devices('myDevice').switchOn()
else
dz.log('Device myDevice does not exist!', dz.LOG_ERROR)
end

local myName = _u.deviceExists(123)
if myName then
dz.log('Device 123 is ' .. myName, dz.LOG_INFO)
else
dz.log('Device 123 does not exist', dz.LOG_ERROR)
end</syntaxhighlight></li>
<li>'''dumpTable(table,[levelIndicator],[osfile]3.0.0))''': ''Function'': print table structure and contents to log</li>
<li>'''fileExists(path)''': ''Function'': Returns <code>true</code> if the file (with full path) exists.</li>
<li>'''fromBase64(string)''': ''Function'': Decode a base64 string</li>
<li>'''fromJSON(json, fallback, deSerialize 3.1.8 )''': ''Function''. Turns a json string to a Lua table. Example: <code>local t = domoticz.utils.fromJSON('{ "a": 1 }')</code>. Followed by: <code>print( t.a )</code> will print 1. Optional 2nd param fallback will be returned if json is nil or invalid. Optional 3rd param deSerialize (boolean) determines if the JSON should be deserialized before converting.</li>
<li>'''fromXML(xml, fallback )''': ''Function'': Turns a xml string to a Lua table. Example: <code>local t = domoticz.utils.fromXML('<testtag>What a nice feature!</testtag>') Followed by:</code>print( t.texttag)` will print What a nice feature! Optional 2nd param fallback will be returned if xml is nil or invalid.</li>
<li>'''fuzzyLookup([string|array of strings], parm)''': ''Function'': 3.0.14. Search fuzzy matching string in parm. If parm is string it returns a number (lower is better match). If parm is array of strings it returns the best matching string.</li>
<li>'''groupExists(parm)''': ''Function'': returns name when entered with a valid group 3.0.12 or groupID and return ID when entered with valid groupName or false when not a group, groupID or groupName of an existing group</li>
<li>'''hardwareExists(parm)''': ''Function'': 3.0.7 returns name when entered with valid hardwareID or ID when entered with valid hardwareName or false when not a hardwareID or hardwareName of an existing (and active )hardware module</li>
<li>'''inTable(table, searchString)''': ''Function'': Returns <code>"key"</code> if table has searchString as a key, <code>"value"</code> if table has searchString as value and <code>false</code> otherwise.</li>
<li>'''isJSON(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘application/json’ or string is enclosed in {} and <code>false</code> otherwise.</li>
<li>'''isXML(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘text/xml’ or ‘application/xml’ or string is enclosed in <> and <code>false</code> otherwise.</li>
<li>'''leftPad(string, length [, character])''': ''Function'': Precede string with given character(s) (default = space) to given length.</li>
<li>'''centerPad(string, length [, character])''': ''Function'': Center string by preceding and succeeding with given character(s) (default = space) to given length.</li>
<li>'''numDecimals(number [, integer [, decimals ]])''': ''Function'': Format number to float representation. ''Examples:''</li></ul>

<syntaxhighlight lang="lua"> domoticz.utils.numDecimals(12.23, 4, 4) -- => 12.2300,
domoticz.utils.numDecimals (12.23,1,1) -- => 12.2,
domoticz.utils.leadingZeros(domoticz.utils.numDecimals (12.23,4,4),9) -- => 0012.2300</syntaxhighlight>
<ul>
<li>'''osCommand(cmd)''': ''Function'': 3.0.13 Execute an OS command and return result and returncode. Note: For long running scripts <code>domoticz.executeShellCommand()</code> should be used, See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''osExecute(cmd)''': ''Function'': Execute an OS command (no return). Note: For long running scripts <code>executeShellCommand()</code> should be used. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''rightPad(string, length [, character])''': ''Function'': Succeed string with given character(s) (default = space) to given length.</li>
<li>'''round(number, [decimalPlaces])''': ''Function''. Helper function to round numbers. Default decimalPlaces is 0.</li>
<li>'''sceneExists(parm)''': ''Function'': returns name when entered with valid scene 3.0.12 or sceneID and return ID when entered with valid sceneName or false when not a scene, sceneID or sceneName of an existing scene</li>
<li>'''setLogMarker([marker])''': ''Function'': set logMarker to ‘marker’. Defaults to scriptname. Can be used to change logMarker based on flow in script</li>
<li>'''splitLine(string , splitOnWord ) 3.1.8)''':''Function''. Helper function to split a line. Return is a table with line-segments.</li>
<li>'''stringSplit(string [,separator ] [,convertNumber ][,convertNil ]3.0.17)''':''Function''. Helper function to split a line in separate words. Default separator is space. Return is a table with separated words. Default convertNumber is false when set to true it will convert strings to number where possible. Word is ignored when nil, unless convertNil is set; in that case word will be set to the convertNil value.</li>
<li>'''stringToSeconds(str)''': ''Function'': 3.0.1 Returns number of seconds between now and str. ''Examples:''
<syntaxhighlight lang="lua">domoticz.utils.stringToSeconds('09:00') -- number of seconds between now and 09:00 hr.
domoticz.utils.stringToSeconds('08:53:30 on fri') -- number of seconds between now and Friday at 08:53:30
domoticz.utils.stringToSeconds('08:53:30 on sat, sun') -- number of seconds between now and Saturday or Sunday at 08:53:30 ;whatever comes first</syntaxhighlight></li>
<li>'''toBase64(string)''': ''Function'': ) Encode a string to base64</li>
<li>'''toCelsius(f, relative)''': ''Function''. Converts temperature from Fahrenheit to Celsius along the temperature scale or when relative == true it uses the fact that 1F = 0.56C. So <code>toCelsius(5, true)</code> returns 5F*(1/1.8) = 2.78C.</li>
<li>'''toJSON(luaTable)''': ''Function''. Converts a Lua table to a json string.</li>
<li>'''toXML(luaTable, [header])''': ''Function''. Converts a Lua table to a xml string.</li>
<li>'''urlDecode(s)''': ''Function''. Simple deCoder to convert a string with escaped chars (%20, %3A and the likes) to human readable format.</li>
<li>'''urlEncode(s, [strSub])''': ''Function''. Simple url encoder for string so you can use them in <code>openURL()</code>. <code>strSub</code> is optional and defaults to + but you can also pass %20 if you like/need.</li>
<li>'''variableExists(parm)''': ''Function'': returns name when entered with a valid variable 3.0.12 or variableID and return ID when entered with valid variableName or false when not a variable, variableID or variableName of an existing variable</li>
<li>'''leadingZeros(number, length)''': ''Function'': Precede number with given zeros to given length.</li>
<li>'''variables(idx/name)''': ''Function''. A function returning a variable by it’s name or idx. See [Variable object API] (#Variable_object_API_.28user_variables.29) for the attributes. To iterate over all variables do: <code>domoticz.variables().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. '''Note that you cannot do <code>for i, j in pairs(domoticz.variables()) do .. end</code>'''.</li></ul></li></ul>


=== Looping through the collections: iterators ===

The domoticz object has these collections (tables): devices, scenes, groups, variables, changedDevices and changedVariables. You cannot use the <code>pairs()</code> or <code>ipairs()</code> functions. Therefore dzVents has four iterator methods:

# '''find(function)''': Returns the item in the collection for which <code>function</code> returns true. When no item is found <code>find</code> returns nil.
# '''forEach(function)''': Executes function once per array element. The function receives the item in the collection (device or variable). If the function returns ''false'', the loop is aborted.
# '''filter(function / table)''': returns items in the collection for which the function returns true. You can also provide a table with names and/or ids.
# '''reduce(function, initial)''': Loop over all items in the collection and do some calculation with it. You call it with the function and the initial value. Each iteration the function is called with the accumulator and the item in the collection. The function does something with the accumulator and returns a new value for it.


==== Examples: ====

find():

<syntaxhighlight lang="lua"> local myDevice = domoticz.devices().find(function(device)
return device.name == 'myDevice'
end)
domoticz.log('Id: ' .. myDevice.id)</syntaxhighlight>
forEach():

<syntaxhighlight lang="lua"> domoticz.devices().forEach(function(device)
if (device.batteryLevel < 20) then
-- do something
end
end)</syntaxhighlight>
filter():

<syntaxhighlight lang="lua"> local deadDevices = domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end)
deadDevices.forEach(function(zombie)
-- do something
end)</syntaxhighlight>
or

<syntaxhighlight lang="lua"> local livingLights = {
'window',
'couch',
33, -- kitchen light id
}
local lights = domoticz.devices().filter(livingLights)
lights.forEach(function(light)
-- do something
light.switchOn()
end)</syntaxhighlight>
Of course you can chain:

<syntaxhighlight lang="lua"> domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end).forEach(function(zombie)
-- do something with the zombie
end)</syntaxhighlight>
Using a reducer to count all devices that are switched on:

<syntaxhighlight lang="lua"> local count = domoticz.devices().reduce(function(acc, device)
if (device.state == 'On') then
acc = acc + 1 -- increase the accumulator
end
return acc -- always return the accumulator
end, 0) -- 0 is the initial value for the accumulator</syntaxhighlight>

=== Constants ===

The domoticz object has these constants available for use in your code e.g. <code>domoticz.LOG_INFO</code>.

'''IMPORTANT: you have to prefix these constants with the name of your domoticz object. Example: <code>domoticz.ALERTLEVEL_RED</code>''':

* '''ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_ORANGE, ALERTLEVEL_RED, ALERTLEVEL_YELLOW''': for updating text sensors.
* '''BASETYPE_CUSTOM_EVENT 3.0.0,BASETYPE_DEVICE, BASETYPE_SCENE, BASETYPE_GROUP, BASETYPE_HARDWARE''' 3.0.7, '''BASETYPE_VARIABLE, BASETYPE_SECURITY, BASETYPE_TIMER, BASETYPE_HTTP_RESPONSE, BASETYPE_SYSTEM'''3.0.0: indicators for the various object types that are passed as the second parameter to the execute function. E.g. you can check if an object is a device object: <code>Lua if (item.baseType == domoticz.BASETYPE_DEVICE) then ... end</code>
* '''BARO_CLOUDY, BARO_CLOUDY_RAIN, BARO_STABLE, BARO_SUNNY, BARO_THUNDERSTORM, BARO_NOINFO, BARO_UNSTABLE, BARO_COMPUTE''' : for updating barometric values.
* '''EVENT_TYPE_DEVICE, EVENT_TYPE_VARIABLE, EVENT_TYPE_CUSTOM''', 3.0.0 '''EVENT_TYPE_SECURITY, EVENT_TYPE_HTTPRESPONSE, EVENT_TYPE_SYSTEM,''' 3.0.0 '''EVENT_TYPE_TIMER''': triggerInfo types passed to the execute function in your scripts.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_TEMPORARY_OVERRIDE, EVOHOME_MODE_PERMANENT_OVERRIDE, EVOHOME_MODE_FOLLOW_SCHEDULE''': mode for EvoHome system.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_AUTOWITHRESET, EVOHOME_MODE_AUTOWITHECO, EVOHOME_MODE_AWAY, EVOHOME_MODE_DAYOFF, EVOHOME_MODE_CUSTOM, EVOHOME_MODE_HEATINGOFF''' : mode for EvoHome controller
* '''HUM_COMFORTABLE, HUM_DRY, HUM_NORMAL, HUM_WET, HUM_COMPUTE''' 3.0.15: constant for humidity status.
* '''INTEGER, FLOAT, STRING, DATE, TIME''': variable types.
* \**LOG_INFO, LOG_STATUS, LOG_ERROR, LOG_DEBUG, LOG_FORCE: for logging messages. LOG_FORCE will always be displayed.
* '''NSS_CLICKATELL''' 3.1.3, '''NSS_FIREBASE, NSS_FIREBASE_CLOUD_MESSAGING, NSS_GOOGLE_DEVICES,''' 3.0.10 Only with installed casting plugin, '''NSS_HTTP, NSS_KODI, NSS_LOGITECH_MEDIASERVER, NSS_NMA,NSS_PROWL, NSS_PUSHALOT, NSS_PUSHBULLET, NSS_PUSHOVER, NSS_PUSHSAFER, NSS_TELEGRAM, NSS_GOOGLE_CLOUD_MESSAGING''' deprecated by Google and replaced by firebase: for notification subsystem
* '''PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY''': for notification priority.
* '''SECURITY_ARMEDAWAY, SECURITY_ARMEDHOME, SECURITY_DISARMED''': for security state.
* '''STATE_IDLE, STATE_COOLING, STATE_HEATING''': for thermostat operating state.
* '''SOUND_ALIEN , SOUND_BIKE, SOUND_BUGLE, SOUND_CASH_REGISTER, SOUND_CLASSICAL, SOUND_CLIMB , SOUND_COSMIC, SOUND_DEFAULT, SOUND_ECHO, SOUND_FALLING, SOUND_GAMELAN, SOUND_INCOMING, SOUND_INTERMISSION, SOUND_MAGIC, SOUND_MECHANICAL, SOUND_NONE, SOUND_PERSISTENT, SOUND_PIANOBAR , SOUND_SIREN, SOUND_SPACEALARM, SOUND_TUGBOAT, SOUND_UPDOWN''': for notification sounds.


== Custom event API ==

If you have a dzVents script that is triggered by a customEvent in Domoticz then the second parameter passed to the execute function will be a ''notification'' object. The object.type = customEvent (isCustomEvent: true) and object.data contains the passed data to this script. object.trigger is the name of the customEvent that triggered the script.


== Device object API ==

If you have a dzVents script that is triggered by switching a device in Domoticz then the second parameter passed to the execute function will be a ''device'' object. Also, each device in Domoticz can be found in the <code>domoticz.devices()</code> collection (see above). The device object has a set of fixed attributes like ''name'' and ''idx''. Many devices, however, have different attributes and methods depending on their (hardware)type, subtype and other device specific identifiers. It is possible that you will get an error if you call a method on a device that doesn’t support it, so please check the device properties for your specific hardware to see which are supported (can also be done in your script code!).

dzVents recognizes most of the different device types in Domoticz and creates the proper attributes and methods. It is possible that your device type has attributes that are not recognized; if that’s the case, please create a ticket in the Domoticz [https://github.com/domoticz/domoticz/issues issue tracker on GitHub], and an adapter for that device will be added.

If for some reason you miss a specific attribute or data for a device, then likely the <code>rawData</code> attribute will have that information.


== Device attributes and methods for all devices ==

<ul>
<li>'''active''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Same as bState.</li>
<li>'''baseType''' ''String''. ‘camera’, ‘device’, ‘group’, ‘scene’, ‘hardware’, ‘uservariable’ or ‘security’</li>
<li>'''batteryLevel''': ''Number'' If applicable for that device then it will be from 0-100.</li>
<li>'''bState''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Better to use active.</li>
<li>'''changed''': ''Boolean''. True if the device was updated. '''Note''': This does not necessarily means the device state or value changed.</li>
<li>'''customImage''': ''Number''. When customImage is used for the device-icon this will be the icon-number. It will be 0 if the icon was not changed.</li>
<li>'''description''': ''String''. Description of the device.</li>
<li>'''deviceId''': ''String''. Another identifier of devices in Domoticz. dzVents uses the id(x) attribute. See device list in Domoticz’ settings table.</li>
<li>'''deviceSubType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''deviceType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''dump()''': ''Function''. Dump all attributes except functions and complete time overview to the Domoticz log. This ignores the log level setting. Use fullDump to include everything.</li>
<li>'''dumpSelection([{‘attributes’} ‘functions’ ‘tables’])''': ''Function''. 3.0.5 Dump attributes, function-names or table-names to the Domoticz log. This ignores the log level setting.</li>
<li>'''fullDump()''' ''Function''. 3.1.16 Dump all attributes including functions and the complete time overview to the Domoticz log. This ignores the log level setting. Most of the time dump() shows everything what is needed to debug.</li>
<li>'''hardwareName''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareId''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''icon''': ''String''. Name of the icon in Domoticz GUI.</li>
<li>'''id''': ''Number''. Index of the device. You can find the index in the device list (idx column) in Domoticz settings. It’s not truly an index but is unique enough for dzVents to be treated as an id.</li>
<li>'''idx''': ''Number''. Same as id: index of the device</li>
<li>'''inActive''': ''Boolean''. 3.1.0 true if active is false and vice versa. If active is nil inActive is also nil</li>
<li>'''lastUpdate''': ''[[#Time_object|Time Object]]'': Time when the device was updated. **Note: The lastUpdate for devices that triggered the script at hand is in fact the previousUpdate time. The real lastUpdate time for these “script triggering” devices is the current time.</li>
<li>'''name''': ''String''. Name of the device.</li>
<li>'''nValue''': ''Number''. Numerical representation of the state.</li>
<li>'''protected''': ''Boolean''. True when device / scene / group is protected. False otherwise.</li>
<li>'''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]</li>
<li>'''protectionOn()''': ''Function''. switch protection to on. Supports some [command options] !! **Note: domoticz protects against GUI and API access only. switchOn / switchOff type Blockly / Lua / dzVents commands are not influenced (because they are executed as admin user)</li>
<li>'''rawData''': ''Table'': All values are ''String'' types and hold the raw data received from Domoticz.</li>
<li>'''rename(newName)''': ''Function''. Change current devicename to new devicename Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setDescription(description)''': ''Function''. Generic method to update the description for all devices, groups and scenes. E.g.: device.setDescription(device.description .. ‘/nChanged by’.. item.trigger .. ‘at’ .. domoticz.time.raw). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setIcon(iconNumber)''': ''Function''. method to update the icon for devices. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setState(newState)''': ''Function''. Generic update method for switch-like devices. E.g.: device.setState(‘On’). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''resumeTimerPlan()''': ''Function''. Finds the most recent timer that should have fired today (before now) for this device, scene, or group and executes it immediately. Useful for restoring the correct state after a Domoticz restart or power cut. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. ```lua – Replay last timer for a device domoticz.devices(‘My Light’).resumeTimerPlan()
– Replay last timer for a scene domoticz.scenes(‘Evening Scene’).resumeTimerPlan()
– Replay last timer for a group domoticz.groups(‘All Lights’).resumeTimerPlan() ```</li>
<li>'''setValues(nValue,[ sValue1, sValue2, …])''': ''Function''. Generic alternative method to update device nValue, sValues. Uses domoticz JSON API to force subsequent pushes like influxdb and MQTT. nValue required but when set to nil it defaults to current nValue. sValue parms are optional and can be many. 3.0.8 If one of sValue parms is ‘parsetrigger’, subsequent eventscripts will be triggered.</li>
<li>'''state''': ''String''. For switches, holds the state like ‘On’ or ‘Off’. For dimmers that are on, it is also ‘On’ but there is a level attribute holding the dimming level. '''For selector switches''' (Dummy switch) the state holds the ''name'' of the currently selected level. The corresponding numeric level of this state can be found in the '''rawData''' attribute: <code>device.rawData[1]</code>.</li>
<li>'''signalLevel''': ''Number'' If applicable for that device then it will be from 0-12</li>
<li>'''switchType''': ''String''. See Domoticz devices table in Domoticz GUI(Switches tab). E.g. ‘On/Off’, ‘Door Contact’, ‘Motion Sensor’ or ‘Blinds’</li>
<li>'''sValue''': ''String''. Returns the sValue (string Value) of a device.</li>
<li>'''switchTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''timedOut''': ''Boolean''. Is true when the device couldn’t be reached.</li>
<li>'''unit''': ''Number''. Device unit. See device list in Domoticz’ settings for the unit.</li>
<li>'''update(< params >)''': ''Function''. Generic update method. Accepts any number of parameters that will be sent back to Domoticz. There is no need to pass the device.id here. It will be passed for you. Example to update a temperature: <code>device.update(0,12)</code>. This will eventually result in a commandArray entry <code>['UpdateDevice']='<idx>|0|12'</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''updateQuiet(nValue, sValue)''': ''Function''. 3.0.18 Uses the JSON/API to send nValue and/or sValue to domoticz (at least one should be supplied). Will update the device status in the GUI and trigger events but will not execute the action on the device. Only useful when the status in the GUI is not in line with the actual status. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li></ul>


=== Device attributes and methods for specific devices ===

Note that if you do not find your specific device type here you can always inspect what is in the <code>rawData</code> attribute. Please let us know that it is missing so we can write an adapter for it (or you can write your own and submit it). Calling <code>myDevice.dump()</code> will dump all attributes and values for myDevice to the Domoticz log.


==== Air quality ====

* '''co2''': ''Number''. PPM
* '''quality''': ''String''. Air quality string.
* '''updateAirQuality(ppm)''': Pass the CO2 concentration. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Alert sensor ====

* '''color''': ''Number''. Color of the alert. See domoticz color constants for possible values.
* '''text''': ''String''
* '''updateAlertSensor(level, text)''': ''Function''. Level can be domoticz.ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_YELLOW, ALERTLEVEL_ORANGE, ALERTLEVEL_RED. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 1-phase ====

* '''current''': ''Number''. Ampère.
* '''updateCurrent(current)''': ''Function''. Current in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 3-phase ====

* '''current1''', '''current2''', '''current3''' : ''Number''. Ampère.
* '''updateCurrent(current1, current2, current3)''': ''Function''. Currents in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Barometer sensor ====

* '''barometer'''. ''Number''. Barometric pressure.
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''updateBarometer(pressure, forecast)''': ''Function''. Update barometric pressure. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Counter, managed Counter, counter incremental ====

* '''counter''': ''Number''
* '''counterToday''': ''Number''. Today’s counter value.
* '''updateCounter(value)''': ''Function''. '''Overwrite current value for managed and standard counters; increment for incremental counters !!'''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateHistory( date, sValues )''': ''Strings'' 3.1.3 ''function'' Managed counter only! Used to write values to short or long term storage.

<syntaxhighlight lang="lua"> local mCounter = domoticz.devices('device name')
mCounter.updateHistory('2021-01-22', '10;1777193') -- Write to long term storage (meter_calendar table)
mCounter.updateHistory('2021-01-22 10:05:02', '10;1777193') -- Write to short term storage (meter table)</syntaxhighlight>
* '''incrementCounter(value)''': ''Function''. (counter incremental) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. To update with a complete new value you will have to do some calculation and take the counter divider into account.

<syntaxhighlight lang="lua"> local newValue = value
local iCounter = domoticz.devices('device name')
local counterDivider = x -- x is depending on the counter divider set for the device
iCounter.incrementCounter( ( -1 * iCounter.counter * counterDivider ) + newValue )</syntaxhighlight>
* '''valueQuantity''': ''String''. For counters.
* '''valueUnits''': ''String''.


==== Custom sensor ====

* '''sensorType''': ''Number''.
* '''sensorUnit''': ''String'':
* '''sensorValue''': 3.0.11 ''Number'' where applicable; else ''String'':
* '''updateCustomSensor(value)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Distance sensor ====

* '''distance''': ''Number''.
* '''updateDistance(distance)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Electric usage ====

* '''actualWatt''': ''Number''. Current Watt usage.
* '''WhActual''': ''Number''. Current Watt usage. (please use actualWatt)
* '''updateEnergy(energy)''': ''Function''. In Watt. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Evohome (controller) ====

* '''mode''': ''string'' 3.0.0.
* '''setMode(mode, dparm, action, ooc )''': ''Function''. set mode for controller. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_AUTOWITHRESET, domoticz.EVOHOME_MODE_AUTOWITHECO, domoticz.EVOHOME_MODE_AWAY, domoticz.EVOHOME_MODE_DAYOFF, domoticz.EVOHOME_MODE_CUSTOM or domoticz.EVOHOME_MODE_HEATINGOFF. dParm <optional> can be a future time string (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>), a future time object, a future time as number of seconds since epoch or a number representing a positive offset in minutes (max 1 year). action <optional> (1 = run on action script, 0 = disable), ooc <optional> (1 = only trigger the event & log on change, 0 = always trigger & log)


==== Evohome (hotWater) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''mode''': ''string''
* '''untilDate''': ''string in ISO 8601 format'' or n/a.
* '''setHotWater(state, mode, until)''': ''Function''. set HotWater Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE You can provide an until date (in ISO 8601 format for domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>).


==== Evohome (relay) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''level''': ''number'' (level percentage)
* '''active''': ''boolean'' (true when state is not equal to ‘Off’, false otherwise)


==== Evohome (zones) ====

* '''setPoint''': ''Number''.
* '''mode''': ''string'' .
* '''untilDate''': ''string in ISO 8601 format'' or n/a .
* '''updateSetPoint(setPoint, mode, until)''': ''Function''. Update set point. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE. You can provide an until date (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>). When leaving out untilDate for mode domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE the untilDate will be the next scheduled zone-update time/date. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Gas ====

* '''counter''': ''Number''. Value in m3
* '''counterToday''': ''Number''. Value in m3
* '''updateGas(usage)''': ''Function''. Usage in '''dm3''' (liters). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Group ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current group-name to new group-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleGroup()''': Toggles the state of a group. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Hardware 3.0.7 ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''isHardware''': ''Boolean''
* '''isPythonPlugin''': ''Boolean''
* '''type''': : ''String''
* '''typeValue''': : ''Number''


==== Humidity sensor ====

* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''updateHumidity(humidity, status)''': Update humidity. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Kodi ====

* '''kodiExecuteAddOn(addonId)''': ''Function''. Will send an Execute Addon command sending no parameters. Addon IDs are embedded in the addon configuration and are not to be confused with the Addon Name. For example: http://forums.homeseer.com/showthread.php?p=1213403.
* '''kodiPause()''': ''Function''. Will send a Pause command, only effective if the device is streaming.
* '''kodiPlay()''': ''Function''. Will send a Play command, only effective if the device was streaming and has been paused.
* '''kodiPlayFavorites([position])''': ''Function''. Will play an item from the Kodi’s Favorites list optionally starting at ''position''. Favorite positions start from 0 which is the default.
* '''kodiPlayPlaylist(name, [position])''': ''Function''. Will play a music or video Smart Playlist with ''name'' optionally starting at ''position''. Playlist positions start from 0 which is the default.
* '''kodiSetVolume(level)''': ''Function''. Set the volume for a Kodi device, 0 <= level <= 100.
* '''kodiStop()''': ''Function''. Will send a Stop command, only effective if the device is streaming.
* '''kodiSwitchOff()''': ''Function''. Will turn the device off if this is supported in settings on the device.


==== kWh, Electricity (instant and counter) ====

* '''actualWatt''': ''Number''. Actual usage in Watt.
* '''counterToday''': ''Number''.
* '''updateElectricity(power, energy)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''WhToday''': ''Number''. Total Wh usage of the day. Note the unit is Wh and not kWh!
* '''WhTotal''': ''Number''. Total Wh usage.
* '''WhActual''': ''Number''. Actual reading in Watt. Please use actualWatt


==== Leaf wetness ====

* '''wetness''': ''Number''. Wetness value
* '''updateWetness(wetness)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Logitech Media Server ====

* '''pause()''': ''Function''. Will pause the device if it was streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''play()''': ''Function''. If the device was off, it will turn on and start streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playFavorites([position])''': ''Function''. Will start the favorites playlist. <code>position</code> is optional (0 = default). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playlistID''': ''Nubmer''.
* '''setVolume(level)''': ''Function''. Sets the volume (0 <= level <= 100). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''startPlaylist(name)''': ''Function''. Will start the playlist by its <code>name</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Will stop the device (only effective if the device is streaming). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeUp()''': ''Function''. Will turn the device volume up with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeDown()''': ''Function''. Will turn the device volume down with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Lux sensor ====

* '''lux''': ''Number''. Lux level for light sensors.
* '''updateLux(lux)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Onkyo receiver ====

* '''onkyoEISCPCommand(command)'''. ''Function''. Sends an EISP command to the Onkyo receiver.


==== OpenTherm gateway ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== P1 Smart meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterToday''': ''Number''.
* '''usage1''', '''usage2''': ''Number''.
* '''return1''', '''return2''': ''Number''.
* '''updateP1(usage1, usage2, return1, return2, cons, prod)''': ''Function''. Updates the device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''usageDelivered''': ''Number''.


==== Percentage ====

* '''percentage''': ''Number''.
* '''updatePercentage(percentage)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Philips Hue Light ====

See switch below.


==== Pressure ====

* '''pressure''': ''Number''.
* '''updatePressure(pressure)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Rain meter ====

* '''rain''': ''Number'' (please note that this does return the rain total for today)
* '''rainRate''': ''Number''
* '''updateRain(rate, counter)''': ''Function''. (rate in mm * 100 per hour, counter is total in mm) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== RGBW(W) / Lighting Limitless/Applamp ====

* '''decreaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''getColor()'''; ''Function''. Returns table with color attributes or nil when color field of device is not set.
* '''increaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''setColor(r, g, b, br, cw, ww, m, t)''': ''Function''. Sets the light to requested color. r, g, b required, others optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. Meaning and limits of parms can be found [https://wiki.domoticz.com/Domoticz_API/JSON_URL's#Set_a_light_to_a_certain_color_or_color_temperature here].
* '''setColorBrightness()''': same as setColor
* '''setDiscoMode(modeNum)''': deprecated because only very limited supported and will be removed from API
* '''setHex(r, g, b)''': ''Function''. Sets the light to requested color. r, g, b required (decimal Values 0-255). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setHue(hue, brightness, isWhite)''': ''Function''. Sets the light to requested Hue. Hue and brightness required. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setKelvin(Kelvin)''': ''Function''. Sets Kelvin level of the light (For RGBWW devices only). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setNightMode()''': ''Function''. Sets the lamp to night mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setRGB(red, green, blue)''': ''Function''. Set the lamps RGB color. Values are from 0-255. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setWhiteMode()''': ''Function''. Sets the lamp to white mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scale weight ====

* '''weight''': ''Number''
* '''udateWeight()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scene ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current scene-name to new scene-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Security Panel ====

Create a security device:

# Set a security panel password in Domoticz settings.
# Activate the security panel ('''Setup > More Options > Security Panel''' and set it to '''Disarm''' (using your password)).
# Go to the device list in ('''Setup > Devices''') where it should show the security panel device under ‘Not used’.
# Add the device and give it a name.

Methods/attributes:

* '''armAway()''': Sets a security device to Armed Away. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''armHome()''': Sets a security device to Armed Home. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''disarm()''': Disarms a security device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''state''': ''String'': Same values as domoticz.security value.


==== Smoke detection ====

* '''activate()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''reset()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Solar radiation ====

* '''radiation'''. ''Number''. In Watt/m2.
* '''updateRadiation(radiation)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Soil moisture ====

* '''moisture'''. ''Number''. In centibars (cB).
* '''updateSoilMoisture(moisture)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Sound level ====

* '''level'''. ''Number''. In dB.
* '''updateSoundLevel(level)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Switch (dimmer, selector etc.) ====

There are many switch-like devices. Not all methods are applicable for all switch-like devices. You can always use the generic <code>setState(newState)</code> method.

* '''close()''': ''Function''. Set device to Close if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''dimTo(percentage)''': ''Function''. Switch a dimming device on and/or dim to the specified level. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''lastLevel''': Number. The level of a dimmer just before it was switched off. '''Note: lastLevel only shows you the previous level if you have a trigger for the device itself. So for instance you have a on-trigger for ‘myDimmer’ and the dimmer is set from 20% to 30%, in your script <code>myDimmer.level == 30</code> and <code>myDimmer.lastLevel == 20</code>. '''
* '''level''': ''Number''. For dimmers and other ‘Set Level..%’ devices this holds the level like selector switches.
* '''levelActions''': ''String''. |-separated list of url actions for selector switches.
* '''levelName''': ''String''. Current level name for selector switches.
* '''levelNames''': ''Table''. Table holding the level names for selector switch devices.
* '''levelVal''': ''Number''. Specific for selector switches.
* '''maxDimLevel''': ''Number''.
* '''open()''': ''Function''. Set device to Open if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOn()''': ''Function''. Set deviceStatus to on without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOff()''': ''Function''. set deviceStatus to off without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setLevel(percentage)''': ''Function''. Set device to a given level if it supports it (e.g. blinds percentage). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Set device to Stop if it supports it (e.g. blinds). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Switch device off it is supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Switch device on if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchSelector(<[level]|[levelname] >)''' : ''Function''. Switches a selector switch to a specific level ( levelname or level(numeric) required ) levelname must be exact, for level the closest fit will be picked. See the edit page in Domoticz for such a switch to get a list of the values). Levelname is only supported when level 0 (“Off”) is not removed Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleSwitch()''': ''Function''. Toggles the state of the switch (if it is togglable) like On/Off, Open/Close etc.


==== Temperature sensor ====

* '''temperature''': ''Number''
* '''updateTemperature(temperature)''': ''Function''. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Barometer sensor ====

* '''barometer''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''temperature''': ''Number''
* '''updateTempBaro(temperature, pressure, forecast)''': ''Function''. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity, Barometer sensor ====

* '''barometer''': ''Number''
* '''dewPoint''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHumBaro(temperature, humidity, status, pressure, forecast)''': ''Function''. forecast can be domoticz.BARO_NOINFO, BARO_SUNNY, BARO_PARTLY_CLOUDY, BARO_CLOUDY, BARO_RAIN. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET, HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity ====

* '''dewPoint''': ''Number''
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHum(temperature, humidity [, status] )''': ''Function''. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET or HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Text ====

* '''text''': ''String''
* '''updateText(text)''': Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat set point ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat Operating state 3.0.19 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat type 3 (Mertik) 3.0.15 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat 6 3.1.11 ====

Thermostat 6 devices come in several subtypes: Temp/Setpoint, Temp/Hum/Setpoint, Temp/Baro/Setpoint and Temp/Hum/Baro/Setpoint.

- '''setPoint''': ''Number''. The current set point.

- '''humidityStatusValue''': ''Number''. Mapped humidity status value (only for subtypes with humidity).

- '''updateSetPoint(setPoint)''': ''Function''. Update the set point. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].

- '''updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)''': ''Function''. Update thermostat values. Parameters depend on the subtype:

- ''Temp/Setpoint'': <code>updateThermostat(temperature, setPoint)</code>

- ''Temp/Hum/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus)</code>

- ''Temp/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, nil, nil, barometer, forecast)</code>

- ''Temp/Hum/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)</code>

- <code>forecast</code> can be a string: <code>'noinfo'</code>, <code>'sunny'</code>, <code>'partlycloudy'</code>, <code>'cloudy'</code>, <code>'rain'</code> or a numeric value. - <code>humidityStatus</code> can be a string: <code>'dry'</code>, <code>'normal'</code>, <code>'comfortable'</code>, <code>'wet'</code> or a numeric value. If omitted with humidity provided, it is auto-calculated.


==== UV sensor ====

* '''uv''': ''Number''. UV index.
* '''updateUV(uv)''': ''Function''. UV index. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Visibility ====

* '''visibility''': ''Number''. In km.
* '''updateVisibility(distance)''':Function*. In km. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Voltage ====

* '''voltage''': ''Number''.
* '''updateVoltage(voltage)''':Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Waterflow ====

* '''flow''': ''Number''. In L/m.
* '''updateWaterflow(flow)''':Function*. In L/m. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Wind ====

* '''chill''': ''Number''.
* '''direction''': ''Number''. Degrees.
* '''directionString''': ''String''. Formatted wind direction like N, SE.
* '''gust''': ''Number''. ( in meters / second, might change in future releases to Meters/Counters settings for Wind Meter )
* '''gustMs''': ''Number''. Gust ( in meters / second )
* '''temperature''': ''Number''
* '''speed''': ''Number''. Windspeed ( in the unit set in Meters/Counters settings for Wind Meter )
* '''speedMs''': ''Number''. Windspeed ( in meters / second )
* '''updateWind(bearing, direction, speed, gust, temperature, chill)''': ''Function''. Bearing in degrees, direction in N, S, NNW etc, speed in m/s, gust in m/s, temperature and chill in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Youless meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterDeliveredTotal''': ''Number''.
* '''powerYield''': ''String''.
* '''updateYouless(total, actual)''': ''Function''.


==== Zone heating ====

* '''setPoint''': ''Number''.
* '''heatingMode''': ''String''.


==== Z-Wave Fan mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Z-Wave Thermostat mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== Command options (delay, duration, event triggering) ===

Many dzVents device methods support extra options, like controlling a delay or a duration:

<syntaxhighlight lang="lua">
-- switch on for 2 minutes after 10 seconds
device.switchOn().afterSec(10).forMin(2)

-- switch on at a specic time / day
device.switchOn().at('09:00') -- earliest moment it will be 09:00 hr.
device.switchOn().at('08:53:30 on fri') -- earliest moment it will be Friday at 08:53:30
device.switchOn().at('08:53:30 on sat, sun') -- earliest moment it will be Saturday or Sunday at 08:53:30 (whatever comes first)

-- switch on for 2 minutes after a randomized delay of 1-10 minutes
device.switchOff().withinMin(10).forMin(2)
device.close().forMin(15)
device.open().afterSec(20)
device.open().afterMin(2)

-- switch on but do not trigger follow up events
device.switchOn().silent()

-- flash a light for 3 times
device.switchOn().forSec(2).repeatAfterSec(1, 3)

-- switch the device on but only if the current state isn't already on:
device.switchOn().checkFirst()
-- this is a short for:
if (device.state == 'Off') then
devices.switchOn()
end</syntaxhighlight>

==== Options ====

* '''at(hh:mm[:ss][ on [ ddd|dddd ] )''': ''Function''.3.0.1 Activates the command at a certain time [ on a certain day]
* '''afterHour(hours), afterMin(minutes), afterSec(seconds)''': ''Function''. Activates the command after a certain number of hours, minutes or seconds.
* '''cancelQueuedCommands()''': ''Function''. Cancels queued commands. E.g. you switch on a device after 10 minutes: <code>myDevice.switchOn().afterMin(10)</code>. Within those 10 minutes you can cancel that command by calling: <code>myDevice.cancelQueuedCommands()</code>.
* '''checkFirst()''': ''Function''. Checks if the '''current''' state of the device is different than the desired new state. If the target state is the same, no command is sent. If you do <code>mySwitch.switchOn().checkFirst()</code>, then no switch command is sent if the switch is already on. This command only works with switch-like devices. It is not available for toggle and dim commands, either.
* '''forHour(hours), forMin(minutes), forSec(seconds)''': ''Function''. Activates the command for the duration of hours, minutes or seconds. See table below for applicability and the warning on unexpected behavior of these functions.
* '''withinHour(hours), withinMin(minutes), withinSec(seconds)''': ''Function''. Activates the command within a certain period (specified in hours, minutes or seconds) ''randomly''. See table below for applicability.
* '''silent()''': ''Function''. No follow-up events will be triggered: <code>mySwitch.switchOff().silent()</code>.
* '''repeatAfterHour(hours, [number]), repeatAfterMin(minutes, [number]), repeatAfterSec(seconds, [number])''': ''Function''. Repeats the sequence ''number'' times after the specified duration (specified in hours, minutes, or seconds). If no ''number'' is provided, 1 is used. '''Note that <code>afterAAA()</code> and <code>withinAAA()</code> are only applied at the beginning of the sequence and not between the repeats!'''

Note that the actual switching or changing of the device is done by Domoticz and not by dzVents. dzVents only tells Domoticz what to do; if the options are not carried out as expected, this is likely a Domoticz or hardware issue.

'''Important note when using forAAA()''': Let’s say you have a light that is triggered by a motion detector. Currently the light is <code>Off</code> and you do this: <code>light.switchOn().forMin(5)</code>. What happens inside Domoticz is this: at t0 Domoticz issues the <code>switchOn()</code> command and schedules a command to restore the '''current''' state at t5 which is <code>Off</code>. So at t5 it will switch the light off.

If, however, ''before the scheduled <code>switchOff()</code> happens at t5'', new motion is detected and you send this command again at t2 then something unpredictable may seem to happen: ''the light is never turned off!'' This is what happens:

At t2 Domoticz receives the <code>switchOn().forMin(5)</code> command again. It sees a scheduled command at t5 and deletes that command (it is within the new interval). Then Domoticz performs the (unnecessary, it’s already on) <code>switchOn()</code> command. Then it checks the current state of the light which is <code>On</code>!! and schedules a command to return to that state at t2+5=t7. So, at t7 the light is switched on again. And there you have it: the light is not switched off and never will be because future commands will always be checked against the current on-state.

That’s just how it works and you will have to deal with it in your script. So, instead of simply re-issuing <code>switchOn().forMin(5)</code> you have to check the switch’s state first:

<syntaxhighlight lang="lua">if (light.active) then
light.switchOff().afterMin(5)
else
light.switchOn().forMin(5)
end</syntaxhighlight>
or issue these two commands ''both'' as they are mutually exclusive:

<syntaxhighlight lang="lua">light.switchOff().checkFirst().afterMin(5)
light.switchOn().checkFirst().forMin(5)</syntaxhighlight>

==== Availability ====

Some options are not available to all commands. All the options are available to device switch-like commands like <code>myDevice.switchOff()</code>, <code>myGroup.switchOn()</code> or <code>myBlinds.open()</code>. For updating (usually Dummy ) devices like a text device <code>myTextDevice.updateText('zork')</code> you can only use <code>silent()</code>. For thermostat setpoint devices and snapshot command silent() is not available. For commands for which dzVents must use openURL, only <code>at()</code> and <code>afterAAA()</code> methods are available. These commands are mainly the setAaaaa() commands for RGBW type devices.

See table below

{| class="wikitable"
!width="17%"| option
!align="center" width="10%"| state changes
!align="center" width="11%"| update commands
!align="center" width="12%"| user variables
!align="center" width="12%"| updateSetpoint
!align="center" width="8%"| snapshot
!align="center" width="10%"| triggerIFTTT
!align="center" width="12%"| execute ShellCommand
!align="center" width="12%"| emitEvent
|-
| <code>afterAAA()</code>1
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>at()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>forAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>withinAAA()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| •
|-
| <code>silent()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>repeatAfterAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>checkFirst()</code>
|align="center"| • 2
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>cancelQueuedCommands()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a

|}

==== Notes on table ====

* '''Note 1''': AAA is a placeholder for <code>Min/Sec/Hour</code> affix e.g. <code>afterMin()</code>.
* '''Note 2''': for <code>domoticz.openURL()</code> only <code>at()</code>, <code>afterAAA()</code> and <code>withinAAA()</code> is available.
* '''Note 3''': Note 2 also applies for all commands depending on openURL (like rgbwwDevice.setAaa() commands).
* '''Note 4''': Including dimTo, switchSelector, setLevel and similar methods.


==== Follow-up event triggers ====

Normally if you issue a command, Domoticz will immediately trigger follow-up events, and dzVents will automatically trigger defined event scripts. If you trigger a scene, all devices in that scene will issue a change event. If you have event triggers for these devices, they will be executed by dzVents. If you don’t want this to happen, add <code>.silent()</code> to your commands (exception is updateSetPoint).


=== Create your own device adapter ===

If your device is not recognized by dzVents, you can still operate it using the generic device attributes and methods. It is much nicer, however, to have device specific attributes and methods. Existing recognized adapters are in <code>/path/to/domoticz/dzVents/runtime/device-adapters</code>. Copy an existing adapter and adapt it to your needs. You can turn debug logging on and inspect the file <code>domoticzData.lua</code> in the dzVents folder. There you will find the unique signature for your device type. Usually it is a combination of deviceType and deviceSubType, but you can use any of the device attributes in the <code>matches</code> function. The matches function checks if the device type is suitable for your adapter and the <code>process</code> function actually creates your specific attributes and methods. Also, if you call <code>myDevice.dump()</code> you will see all attributes and methods and the attribute <code>_adapters</code> shows you a list of applied adapters for that device. Finally, register your adapter in <code>Adapters.lua</code>. Please share your adapter when it is ready and working.


== Variable object API (user variables) ==

User variables created in Domoticz have these attributes and methods:


=== Variable attributes and methods ===

* '''changed''': ''Boolean''. Was the variable updated. '''Note''': update does not necessarily means the variable value or type changed.
* '''date''': ''Date''. If type is domoticz.DATE. See lastUpdate for the sub-attributes.
* '''id''': ''Number''. Index of the variable.
* '''lastUpdate''': ''[[#Time_object|Time Object]]''
* '''name''': ''String''. Name of the variable
* '''rename(newName)''': ''Function''. Change current variable name to new variable name. (does not support timing options)
* '''set(value)''': Tells Domoticz to update the variable. Supports timing options. See [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|above]].
* '''time''': ''Date''. If type is domoticz.TIME. See lastUpdate for the sub-attributes.
* '''type''': ''String''. Can be domoticz.INTEGER, domoticz.FLOAT, domoticz.STRING, domoticz.DATE, domoticz.TIME.
* '''value''': ''String|Number|Date|Time''. Value of the variable.

<syntaxhighlight lang="lua">
return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
end
end
}
</syntaxhighlight>

== Time object ==

Many attributes represent a moment in time, like <code>myDevice.lastUpdate</code> or <code>domoticz.time</code>. In dzVents, a time-like attribute is an object with properties and methods which make your life easier.

<syntaxhighlight lang="lua"> print(myDevice.lastUpdate.minutesAgo)
print(myDevice.lastUpdate.daysAgo)

-- compare two times
print(domoticz.time.compare(myDevice.lastUpdate).secs))</syntaxhighlight>
You can also create your own:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00') -- must be this format!!</syntaxhighlight>
If you don’t pass a time string:

<syntaxhighlight lang="lua"> local Time = require('Time')
local currentTime = Time()</syntaxhighlight>
Use this in combination with the various dzVents time attributes:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00')

local tonight = Time(domoticz.time.rawDate .. ' 20:00:00')
print (tonight.getISO())
-- will print something like: 2016-12-12T20:00:00Z
print(t.minutesAgo) -- difference from 'now' in minutes

-- and you can feed it with all same rules as you use
-- for the timer = { .. } section:
if (t.matchesRule('at 16:00-21:00')) then
-- t is in between 16:00 and 21:00
end

-- very powerful if you want to compare two time instances:
local anotherTime = Time('...') -- fill-in some time here
print(t.compare(anotherTime).secs) -- diff in seconds between t and anotherTime.</syntaxhighlight>

=== System event API ===

If you have a dzVents script that is triggered by a system-event in Domoticz then the second parameter passed to the execute function will be a ''system'' object. The object.type = system-event that triggered the script. ( object.isSystemEvent: true) For backups the object also contains location and durationin seconds.


=== Time properties and methods ===

Creation:

<syntaxhighlight lang="lua">local Time = require('Time')
local now = Time() -- current time
local someTime = Time('2017-12-31 22:19:15')
local utcTime = Time('2017-12-31 22:19:15', true)</syntaxhighlight>
Creation:

<syntaxhighlight lang="lua">local someTime = domoticz.time.addMinutes(30) -- someTime = domoticz time object for now + 30 minutes
local someTime = domoticz.time.makeTime() -- someTime = new domoticz time object.</syntaxhighlight>
* '''addAAA(offset)''': ''time object''. time object with given offset (positive or negative. AAA is a placeholder for <code>Seconds, Minutes, Hours or Days</code> affix e.g. `addHours(-2)
* '''civTwilightEndInMinutes''': ''Number''. Minutes from midnight until civTwilightEnd.
* '''civTwilightStartInMinutes''':''Number''. Minutes from midnight until civTwilightStart.
* '''compare(time)''': ''Function''. Compares the current time object with another time object. ''Make sure you pass a Time object!'' Returns a table (all values are ''positive'', use the compare property to see if ''time'' is in the past or future):
** '''milliseconds''': Total difference in milliseconds.
** '''seconds''': Total difference in whole seconds.
** '''minutes''': Total difference in whole minutes.
** '''hours''': Total difference in whole hours.
** '''days''': Total difference in whole days.
** '''compare''': 0 = both are equal, 1 = ''time'' is in the future, -1 = ''time'' is in the past.
* '''dateToDate( dateString, sourceFormat, targetFormat[ , offSet] )''':3.0.17 ''Function'': Returns a reformatted datestring. dateString is a formatted date and source- and targetFormat are representations of the dateString elements and their locations in the string (see examples in dateToTimestamp) . Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'dddd dd mmmm hh:MM:ss', 1 ) -- > 'Friday 31 December 23:31:06'
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'ddd dd mmm hh:MM:ss', -3600 * 24 - 3 )) -- > 'Thu 30 Dec 23:31:02'</syntaxhighlight>
* '''dateToTimestamp([ dateString [,control] ] )''': ''Function'': Returns ''Number'' representing time since epoch in seconds. dateString is a formatted date and control is a representation of the dateString elements and their location in the string. Default control is ‘yyyy-mm-dd hh:MM’. recognized controls are either a Lua pattern string or a string containing following codes:

<syntaxhighlight lang="lua"> dddd -- full weekdayname(e.g. Wednesday) language depends on locale
ddd -- abbreviated weekdayname(e.g. Wed) language depends on locale
dd -- day of the month {[01-31]
mmmm -- full monthname(e.g September) language depends on locale
mmm -- abbreviated monthname(e.g. Sep) language depends on locale
mm -- month [01-12]
yyyy -- 4 digit year
yy -- 2 digit year
hh -- hour 24-hour clock
ii -- hour 12-hour clock
MM -- minute
ss -- second
W -- weeknumber [01-53]
w -- weekday{[0-6] Sunday-Saturday
datm -- date and time (e.g. 09/16/98 23:48:10) format depends on locale
mer -- either "AM" or "PM" locale
date -- date(e.g. 09/16/98) format depends on locale
time -- time (e.g. 23:48:10)

-- examples:
domoticz.time.dateToTimestamp('2020-12-31 23:59')) -- > 1609455540
domoticz.time.dateToTimestamp('2020-12-31 23:59:01','yyyy-mm-dd hh:MM:ss')) -- > 1609455541
domoticz.time.dateToTimestamp('December 31, 23:59:02','mmmm dd, hh:MM:ss')) -- > 1609455542
domoticz.time.dateToTimestamp('2020-12-31 23:59:03','(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)' )) -- > 1609455543
domoticz.time.dateToTimestamp('20201231235904','(%d%d%d%d)(%d%d)(%d%d)(%d%d)(%d%d)(%d%d)')) -- > 1609455544</syntaxhighlight>
* '''day''': ''Number''
* '''dayAbbrOfWeek''': ''String''. sun,mon,tue,wed,thu,fri or sat
* '''daysAgo''': ''Number''
* '''dayName''': ''String''. complete name Sunday, Monday, etc
* '''dDate''': ''Number''. timestamp (seconds since 01/01/1970 00:00)
* '''getISO''': ''Function''. Returns the ISO 8601 formatted date.
* '''hour''': ''Number''
* '''hoursAgo''': ''Number''. Number of hours since the last update.
* '''isdst''': ''Boolean''. 3.0.18 Indicates if time is in the daylight saving period
* '''isToday''': ''Boolean''. Indicates if time is today
* '''isUTC''': ''Boolean''.
* '''makeTime(string | table,[isUTC])''': ''domoticz time object''. returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. isUTC defaults to false.
* '''matchesRule(rule) ''': ''Function''. Returns true if the rule matches with the time. See [[#timer_trigger_rules|time trigger rules]] for rule examples.
* '''millisecondsAgo''': ''Number''. Number of milliseconds since the last update.
* '''minutes''': ''Number''
* '''minutesAgo''': ''Number''. Number of minutes since the last update.
* '''minutesSinceMidnight''': ''Number''
* '''month''': ''Number''
* '''monthAbbrName''': String. jan, feb, mar, etc
* '''monthName''': ''String''. January, February, etc
* '''msAgo''': ''Number''. Number of milliseconds since the last update.
* '''raw''': ''String''. Generated by Domoticz
* '''rawDate''': ''String''. Returns the date part of the raw data.
* '''rawDateTime''': ''String''. Combined date / time formatted as domoticz does in API / JSON returns (rawDate .. ’ ’.. rawTime )
* '''rawTime''': ''String''. Returns the time part of the raw data as HH:MM:SS
* '''seconds''': ''Number''
* '''secondsSinceMidnight''': ''Number''
* '''secondsAgo''': ''Number''. Number of seconds since the last update.
* '''sunsetInMinutes''': ''Number''. Minutes from midnight until sunset.
* '''sunriseInMinutes''': ''Number''. Minutes from midnight until sunrise.
* '''solarnoonInMinutes''': ''Number''. 3.0.11 Minutes from midnight until solarnoon.
* '''time''': ''String''. Returns the time part of the raw data as HH:MM
* '''timestampToDate([ [ timestamp ] , [ pattern ] ,[ offSet ] )''': ''function''. Returns a datestring. timestamp is number of seconds since epoch (default = now) , pattern is a string as explained in this wiki at the description of the domoticz.time.dateToTimestamp function (default = ‘yyyy-mm-dd hh:MM:ss’). Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.timestampToDate(10,'date time') --> '01/01/70 01:00:10'
domoticz.time.timestampToDate(60,'ddd mm mmm yyyy ii:MM mer','date time') --> 'Thu 01 Jan 1970 01:01 AM''
domoticz.time.timestampToDate(1598077445,'dd/mm/yy ii:MM mer nZero') --> '22/08/20 8:24 AM'</syntaxhighlight>
* '''toUTC(string | table,[offset])''': ''domoticz time object''. 3.0.9 returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. offset defaults to 0.
* '''utcSystemTime''': ''Table''. UTC system time (only when in UTC mode):
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''utcTime''': ''Table''. Time stamp in UTC time:
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''year''': ''Number''
* '''wday''': ''Number'' day of the week. Sunday = 1, Saturday = 7
* '''week''': ''Number'' week of the year

'''Note: it is currently not possible to change the domoticz.time object instance.''' ( but you can create a new one with- or without an offset)


== Shared helper functions ==

It is not unlikely that at some point you want to share Lua code among your scripts. Normally in Lua you would have to create a module and require that module in all you scripts. But dzVents makes that easier for you: Inside your scripts folder or in Domoticz’ GUI web editor, create a <code>global_data.lua</code> script (same as for global persistent data) and feed it with this code:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(param1, param2)
-- do your stuff
end,
MY_CONSTANT = 100 -- doesn't have to be a function
}
}</syntaxhighlight>
Save the file and then you can use myHandyFunction everywhere in your event scripts:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction('bla', 'boo')
print(domoticz.helpers.MY_CONSTANT)
end
}</syntaxhighlight>
No <code>require</code> or <code>dofile</code> is needed.

'''Important note: if you need to access the domoticz object in your helper function you have to pass it as a parameter:'''

Example:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(domoticz, param1, param2)
-- do your stuff
domoticz.log('Hey')
end
}
}</syntaxhighlight>
And pass it along:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction(domoticz, 'bla', 'boo')
end
}</syntaxhighlight>
'''Note''': there can be only '''one''' <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.


== Requiring your own modules ==

If you don’t want to use the helpers support, but you want to require your own modules, place them either in <code>/path/to/domoticz/scripts/dzVents/modules</code> or <code>/path/to/domoticz/scripts/dzVents/scripts/modules</code> as these folders are already added to the Lua package path. You can just require those modules: <code>local myModule = require('myModule')</code>


= Persistent data =

In many situations you need to store a device state or other information in your scripts for later use. Like knowing what the state was of a device the previous time the script was executed or what the temperature in a room was 10 minutes ago. Without dzVents, you had to resort to user variables. These are global variables that you create in the Domoticz GUI and that you can access in your scripts like: domoticz.variables(‘previousTemperature’).

Now, for some this is rather inconvenient and they want to control this state information in the event scripts themselves or want to use all of Lua’s variable types. dzVents has a solution for that: '''persistent script data'''. This can either be on the script level or on a global level.


== Script level persistent variables ==

The values in persistent script variables persist and can be retrieved in the next script run.

For example, send a notification if a switch has been activated 5 times:

<syntaxhighlight lang="lua"> return {
on = {
devices = { 'MySwitch' }
},
data = {
counter = { initial = 0 }
},
execute = function(domoticz, switch)
if (domoticz.data.counter == 5) then
domoticz.notify('The switch was pressed 5 times!')
domoticz.data.counter = 0 -- reset the counter
else
domoticz.data.counter = domoticz.data.counter + 1
end
end
}</syntaxhighlight>
The <code>data</code> section defines a persistent variable called <code>counter</code>. It also defines an initial value. From then on you can read and set the variable in your script.

You do not have to provide an initial value though. In that case the initial value is ''nil'':

<syntaxhighlight lang="lua"> return {
--
data = {
'x', 'y', 'z' -- note the quotes
},
execute = function(domoticz, item)
print(tostring(domoticz.data.x)) -- prints nil
end
}</syntaxhighlight>
You can define as many variables as you like and put whatever value in there that you like. It doesn’t have to be just a number. Just don’t put something in there with functions (well, they are filtered out actually).


=== Size matters and watch your speed!! ===

If you include tables (or arrays) in the persistent data, beware to not let them grow. It will definitely slow down script execution because dzVents has to serialize and deserialize the data. It is better to use the historical option as described below.


=== Re-initializing a variable ===

You can re-initialize a persistent variable and re-apply the initial value as defined in the data section:

<syntaxhighlight lang="lua">return {
on = { .. },
data = {
x = { initial = 'initial value' }
},
execute = function(domoticz, item)
if (domoticz.data.x ~= 'initial value') then
domoticz.data.initialize('x')
print(domoticz.data.x) -- will print 'initial value'
end
end
}</syntaxhighlight>
Note that <code>domoticz.data.initialize('<varname>')</code> is just a convenience method. You can of course create a local variable in your module holding the initial value and use it in your data section and your execute function.


== Global persistent variables ==

Script level variables are only available in the scripts that define them, but global variables can be accessed and changed in every script. To utilize global persistent variables, create a script file called <code>global_data.lua</code> in your scripts folder with this content (same file where you can also put your shared helper functions):

<syntaxhighlight lang="lua"> return {
helpers = {},
data = {
peopleAtHome = { initial = false },
heatingProgramActive = { initial = false }
}
}</syntaxhighlight>
Just define the variables that you need and access them in your scripts:

<syntaxhighlight lang="lua"> return {
on = {
devices = {'WindowSensor'}
},
execute = function(domoticz, windowSensor)
if (domoticz.globalData.heatingProgramActive
and windowSensor.state == 'Open') then
domoticz.notify("Hey don't open the window when the heating is on!")
end
end
}</syntaxhighlight>
'''Note''': there can be only one <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.

You can use <code>domoticz.globalData.initialize('<varname>')</code> just as like <code>domoticz.data.initialize('<varname>')</code>.


== A special kind of persistent variables: ''history = true'' (Historical variables API) ==

In some situations, storing a previous value for a sensor is not enough, and you would like to have more previous values. For example, you want to calculate an average over several readings. Of course you can define a persistent variable holding a table:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
previousData = { initial = {} }
},
execute = function(domoticz, sensor)
-- add new data
table.insert(domoticz.data.previousData, sensor.temperature)

-- calculate the average
local sum = 0, count = 0
for i, temp in pairs(domoticz.data.previousData) do
sum = sum + temp
count = count + 1
end
local average = sum / count
end
}</syntaxhighlight>
The problem with this is that you have to do a lot of bookkeeping to make sure that there isn’t too much data to store (see [[#How_does_the_storage_stuff_work.3F|below for how it works]]) . Fortunately, dzVents has done this for you:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
temperatures = { history = true, maxItems = 10 }
},
execute = function(domoticz, sensor)
-- add new data
domoticz.data.temperatures.add(sensor.temperature)

-- average
local average = domoticz.data.temperatures.avg()

-- maximum value in the past hour:
local max = domoticz.data.temperatures.maxSince('01:00:00')
end
}</syntaxhighlight>

=== Defining ===

Define a script variable or global variable in the data section and set <code>history = true</code>:

<syntaxhighlight lang="lua"> …
data = {
var1 = { history = true, maxItems = 10, maxHours = 1, maxMinutes = 5 }
}</syntaxhighlight>
* '''maxItems''': ''Number''. Controls how many items are stored in the variable. maxItems has precedence over maxHours and maxMinutes.
* '''maxHours''': ''Number''. Data older than <code>maxHours</code> from now will be discarded. E.g., if set to 2, then data older than 2 hours will be removed at the beginning of the script.
* '''maxMinutes''': ''Number''. Same as maxHours but, you guessed it: for minutes this time.. All these options can be combined. '''Reminder: don’t store too much data. Only put in what you really need!'''


=== Adding data ===

Add new values to a historical variable:

<pre>domoticz.data.myVar.add(value)</pre>
As soon as this new value is put on top of the list, the older values shift one place down the line. If <code>maxItems</code> is reached, then the oldest value will be discarded. ''All methods, like calculating averages or sums, will immediately use this new value!'' If you don’t want this to happen, set the new value at the end of your script or after you have done your analysis.

Any kind of data may be stored in the historical variable: numbers, strings, but also more complex data like tables. However, in order to use the [[#Statistical_functions|statistical methods]], numeric values are required.


=== Accessing values in historical variables ===

Values in a historical variable are indexed, where index 1 is the newest value, 2 is the second newest, and so on:

<pre>local item = domoticz.data.myVar.get(5)
print(item.data)</pre>
However, all data in the storage are time-stamped:

<pre>local item = domoticz.data.myVar.getLatest()
print(item.time.secondsAgo) -- access the time stamp
print(item.data) -- access the data</pre>
The time attribute by itself is a table with many properties that help you inspect the data points more easily. See [[#Time_object|Time Object]] for all attributes and methods.


==== Index ====

All data in the set can be addressed using an index. The item with index = 1 is the youngest, and the item with the highest index is the oldest. Beware, if you have called <code>add()</code> first, then the first item is that new value! You can always check the size of the set by inspecting <code>myVar.size</code>.


==== Time specification (''timeAgo'') ====

Every data point in the set has a timestamp and the set is ordered so that the youngest item is the first and the oldest item the last. Many functions require a moment in the past to be specified by passing a string in the format '''<code>hh:mm:ss</code>''', where ''hh'' is the number of hours ago, ''mm'' the number of minutes and ''ss'' the number of seconds. The times are added together, so you don’t have to consider 60 minute boundaries, etc. A time specification of <code>12:88:03</code> is valid, and points to the data point at or around <code>12*3600 + 88*60 + 3 = 48.483 seconds</code> in the past.

Example:

<pre>-- get average for the past 30 minutes:
local avg = myVar.avgSince('00:30:00')</pre>

==== Getting data points ====

* '''get(idx)''': Returns the idx-th item in the set. Same as <code>myVar.storage[idx]</code>.
* '''getAtTime([[#Time_specification_.28timeAgo.29|timeAgo]])''': Returns the data point ''closest'' to the moment as specified by <code>timeAgo</code> and the index in the set. So, <code>myVar.getAtTime('1:00:00')</code> returns the item that is closest to one hour old. It may be a bit younger or a bit older than 1 hour. The second return value is the index in the set: <code>local item, index = myVar.getAtTime('1:00:00')</code>
* '''getLatest( )''': Returns the youngest item in the set. Same as <code>print(myVar.get(1).data)</code>.
* '''getOldest( )''': Returns the oldest item in the set and the index. Same as <code>print(myVar.get(myVar.size).data)</code>. Note that the index is always the same as the total size. <code>local item, index = myVar.getOldest()</code>.
* '''size''': Return the number of data points in the set.
* '''subset( [fromIdx], [toIdx] )''': Returns a subset of the stored data. Default value, if omitted, of <code>fromIdx</code> is 1. Omitting <code>toIdx</code> takes all items until the end of the set (oldest). E.g., <code>myVar.subset()</code> returns all data. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''subsetSince( [[#Time_specification_.28timeAgo.29|timeAgo]] )''': Returns a subset of the stored data since the relative time specified by timeAgo. So calling <code>myVar.subsetSince('00:60:00')</code> returns all items that have been added to the list in the past 60 minutes. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''reset( )''': Removes all the items from the set. It could be a good practice to do this often when you know you don’t need older data. For instance, when you turn on a heater and you just want to monitor rising temperatures starting from this moment when the heater is activated. If you don’t need data points from before, then you may call reset.


==== Looping through the data: iterators ====

Similar to the iterators as described [[#Looping_through_the_collections:_iterators|above]], there are convenience methods to make looping through the data set easier.

* '''forEach(function)''': Loop over all items in the set: E.g.: <code>myVar.forEach( function( item, index, collection) ... end )</code>
* '''filter(function)''': Create a filtered set of items. The function receives the item and returns true if the item is in the result set. E.g. get a set with item values larger than 20: <code>subset = myVar.filter( function (item) return (item.data > 20) end )</code>.
* '''find(function)''': Search for a specific item in the set: E.g. find the first item with a value higher than 20: <code>local item = myVar.find( function (item) return (item.data > 20) end )</code>.
* '''reduce(function, initial)''': Loop over all items in the set and do some calculation with it. You call reduce with the function and the initial value. Each iteration the function is called with the accumulator. The function does something with the accumulator and returns a new value for it. Once you get the hang of it, it is very powerful. Best to give an example. To sum all values:

<syntaxhighlight lang="lua"> local sum = myVar.reduce(function(acc, item)
local value = item.data
return acc + value
end, 0)</syntaxhighlight>
Suppose you want to get data points older than 45 minutes and count the values that are higher than 20 (of course there are more ways to do this):

<syntaxhighlight lang="lua"> local myVar = domoticz.data.myVar

local olderItems = myVar.filter(function (item)
return (item.time.minutesAgo > 45)
end)

local count = olderItems.reduce(function(acc, item)
if (item.data > 20) then
acc = acc + 1
end
return acc
end, 0)

print('Found ' .. tostring(count) .. ' items')</syntaxhighlight>

==== Statistical functions ====

Statistical functions require ''numerical'' data in the set. If the set is just numbers you can do this:

<pre>myVar.add(myDevice.temperature) -- adds a number to the set
myVar.avg() -- returns the average</pre>
If, however, you add more complex data or you want to do a computation first, then you have to ''tell dzVents how to get a numeric value from these data''. So let’s say you do this to add data to the set:

<pre>myVar.add( { 'person' = 'John', waterUsage = u })</pre>
Where <code>u</code> is a variable that got its value earlier. If you want to calculate the average water usage, then dzVents will not be able to do this because it doesn’t know the value is actually in the <code>waterUsage</code> attribute! You will get <code>nil</code>.

To make this work you have to provide a '''getValue function''' in the data section when you define the historical variable:

<syntaxhighlight lang="lua"> return {
active = true,
on = {...},
data = {
myVar = {
history = true,
maxItems = 10,
getValue = function(item)
return item.data.waterUsage -- return number!!
end
}
},
execute = function()...end
}</syntaxhighlight>
This function tells dzVents how to get the numeric value for a data item. '''Note: the <code>getValue</code> function has to return a number!'''.

Of course, if you don’t intend to use any of these statistical functions you can put whatever you want in the set.

<ul>
<li>'''avg( [fromIdx], [toIdx], [default] )''': Calculates the average of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''avgSince([[#Time_specification_.28timeAgo.29|timeAgo]], default )''': Calculates the average of all data points since <code>timeAgo</code>. Returns <code>default</code> if there are no data, otherwise 0. E.g.: <code>local avg = myVar.avgSince('00:30:00')</code> returns the average over the past 30 minutes.</li>
<li>'''med( [fromIdx], [toIdx], [default] )''': Calculates the median of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''min( [fromIdx], [toIdx] )''': Returns the lowest value in the range defined by fromIdx and toIdx.</li>
<li>'''minSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''min''' but now within the <code>timeAgo</code> interval.</li>
<li>'''max( [fromIdx], [toIdx] )''': Returns the highest value in the range defined by fromIdx and toIdx.</li>
<li>'''maxSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''max''' but within the <code>timeAgo</code> interval.</li>
<li>'''sum( [fromIdx], [toIdx] )''': Returns the summation of all values in the range defined by fromIdx and toIdx. It will return 0 when there are no data.</li>
<li>'''sumSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''sum''' but within the <code>timeAgo</code> interval. It will return 0 when there are no data in the interval.</li>
<li>** delta(fromIdx, toIdx, [smoothRange], [default] )**: Returns the delta (difference) between items specified by <code>fromIdx</code> and <code>toIdx</code>. Provide a valid range (no <code>nil</code> values). [Supports data smoothing]. (#Data_smoothing) when providing a <code>smoothRange</code> value. Returns <code>default</code> if there is not enough data. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta(2, 5, 3)</code>.</li>
<li>'''delta2( fromIdx, toIdx, [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''delta''' but now you can control if the smooth values for the ''from-item'' and the ''to-item'' separately. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta2(2, 5, 3, 3)</code>.</li>
<li>'''deltaSince([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRange], [default] )''': Same as '''delta''' but within the <code>timeAgo</code> interval. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSince('00:00:10', 3)</code>.</li>
<li>'''deltaSinceOrOldest([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''deltaSince''' but it will take the oldest value in the set if ''timeAgo'' is older than the age of the entire set. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSinceOrOldest('00:00:10', 3, 3)</code>.</li>
<li>'''localMin( [smoothRange], default )''':</li>
<li>'''localMin( [smoothRange], default )''': Returns the first minimum value (and the item holding the minimal value) in the past. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value. For example, given this range of values in the data set (from new to old): <code>10 8 7 5 3 4 5 6</code>, it will return <code>3</code> because older values ''and'' newer values are higher: a local minimum. Use this if you want to know at what time a temperature started to rise after it had been dropping. E.g.:
<pre> local value, item = myVar.localMin()
print(' minimum was : ' .. value .. ': ' .. item.time.secondsAgo .. ' seconds ago' )</pre></li>
<li>'''localMax([smoothRange], default)''': Same as '''localMin''' but for the maximum value. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value.</li>
<li>'''smoothItem(itemIdx, [smoothRange])''': Returns a the value of <code>itemIdx</code> in the set but smoothed by averaging with its neighbors. The number of neighbors is set by <code>smoothRange</code>. See [[#Data_smoothing|Data smoothing]].</li></ul>


==== Data smoothing ====

Example: Suppose you store temperatures in the historical variable. These temperatures may have extremes. Perhaps these extremes could be due to sensor reading errors. In order to reduce the effect of these so-called spikes, you could smooth out values. It is like blurring the data. The Raw column is your temperatures. The other columns are calculated by averaging the neighbors. For item 10 the calculations are:

<pre>Range=1 for time10 = (25 + 31 + 29) / 3 = 28,3
Range=2 for time10 = (16 + 25 + 31 + 29 + 26) / 5 = 25,4</pre>

{| class="wikitable" style="text-align: center; align="center" width="30% height:10px;"
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"| time
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| raw
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=1
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=2
|-
| '''1'''
| 18
| 20,0
| 21,7
|-
| '''2'''
| 22
| 21,7
| 25,0
|-
| '''3'''
| 25
| 27,3
| 24,6
|-
| '''4'''
| 35
| 27,7
| 26,6
|-
| '''5'''
| 23
| 28,7
| 27,6
|-
| '''6'''
| 28
| 26,0
| 25,8
|-
| '''7'''
| 27
| 23,7
| 23,8
|-
| '''8'''
| 16
| 22,7
| 25,4
|-
| '''9'''
| 25
| 24,0
| 25,6
|-
| '''10'''
| 31
| 28,3
| 25,4
|-
| '''11'''
| 29
| 28,7
| 29,2
|-
| '''12'''
| 26
| 30,0
| 30,2
|-
| '''13'''
| 35
| 30,3
| 30,2
|-
| '''14'''
| 30
| 32,0
| 30,4
|-
| '''15'''
| 31
| 30,3
| 30,8
|-
| '''16'''
| 30
| 29,7
| 28,2
|-
| '''17'''
| 28
| 26,7
| 28,6
|-
| '''18'''
| 22
| 27,3
| 26,2
|-
| '''19'''
| 32
| 24,3
| 25,3
|-
| '''20'''
| 19
| 25,5
| 24,3
|}
A chart illustrates it more clearly. The red line is not smoothed and has more spikes than the others:

[[File:dzvents-smoothing.png|frame|none|alt=|Smoothing]]

Usually a range of 1 or 2 is sufficient when providing a smoothing range to statistical functions. I suggest smoothing when checking deltas, local minimums and maximums.


== How does the storage stuff work? ==

For every script file that defines persisted variables (using the <code>data={ … }</code> section), dzVents will create storage file with the name <code>__data_scriptname.lua</code> in a subfolder called <code>data</code>. You can always delete these data files or the entire storage folder if there is a problem with it:

<pre>domoticz/
scripts/
dzVents/
data/
__data_yourscript1.lua
__data_yourscript2.lua
__data_global_data.lua
examples/
generated_scripts/
scripts/
yourscript1.lua
yourscript2.lua
global_data.lua</pre>
If you dare to, you can watch inside these files. Every time some data are changed, dzVents will stream the changes back into the data files. '''Again, make sure you don’t put too much stuff in your persistent data as it may slow things down too much.'''


= Asynchronous HTTP requests =

dzVents allows you to make asynchronous HTTP request and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use os functions like <code>curl</code> or <code>wget</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz will terminate the script with a message that it took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to make an http call and it is determined by how you use the <code>domoticz.openURL()</code> command. The simplest form simply calls <code>openURL</code> on the domoticz object with only the url as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.openURL('http://domain/path/to/something?withparameters=1')</syntaxhighlight>
After your script is finished, Domoticz will make the request that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a url you pass in a table with all the parameters to make the request '''and''' your provide a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.openURL({
url = 'http://domain/path/to/something',
method = 'POST',
callback = 'mycallbackstring',
postData = {
paramA = 'something',
paramB = 'something else'
}
})
end
}</syntaxhighlight>
In this case, Domoticz will make the request (a POST in this case), and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
httpResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if (response.ok) then -- success
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every 5 seconds'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = '...',
callback = 'trigger'
})
end
if (item.isHTTPResponse) then
if (item.ok) then
...
end
end
end
}</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.openURL(options)''': ''options'' is a Lua table:

* '''url''': ''String''.
* '''method''': ''String''. Optional. Either <code>'GET'</code> (default), <code>'POST'</code>, <code>'PUT'</code>3.0.2 or <code>'DELETE'</code>3.0.2 .
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to trigger the callback handler script(s).
* '''headers''': ''Table / String''. Optional. A Lua table or JSON string with additional http request-headers.
* '''postData''': ''Table / String''. Optional. When doing a <code>POST</code>, <code>PUT</code> 3.0.2 or <code>DELETE</code>3.0.2 this data will be the payload of the request (body). If you provide a Lua table then this will automatically be converted to json and the request-header <code>application/json</code> is set. So no need to do that manually. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': Raw response data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''headers''': ''Table''. Response headers.
* '''isJSON''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'application/json'</code>. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'text/xml'</code>. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be in range of 200-299.
* '''statusCode''': ''Number''. HTTP status codes. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''statusText''': ''String''. HTTP status message. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''protocol''': ''String''. HTTP protocol. See [https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP response status codes].
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


=== More about request and response headers ===

Whenever you do an http request it is not just some data that is sent. Along with the request a bunch of so-called headers are sent along with it. HTTP headers allow the client and the server to pass additional information with the request or the response. Also, in the response there are also headers (response header). These response headers usually tell you what kind of data is returned, if it is compressed, if the request was successful etc.


==== request headers ====

dzVents allow you to set custom request headers that will accompany the data in the request. Sometimes it is necessary to set these headers like for instance when a API or webservice require a security token or key or when the service needs to know what the format of the response data is. Check the documentation of the web service.

So, let’s say you need to call a web service that requires an api key in the headers and the documentation states it needs to be passed in an x-access-token header. Your openURL command then may look like this:

<syntaxhighlight lang="lua">domoticz.openURL({
url = 'https://somedomain.com/service/getInfo',
headers = { ['x-access-token'] = '<api-key>' },
method = 'GET',
callback = 'info'
})</syntaxhighlight>
Check google for more information about request headers. All you need to know here is that dzVents allow you to set these headers.


==== response headers ====

As said earlier, the response also contains a bunch of headers. You can inspect those headers with dzVents but ususally you don’t have to. For starters, dzVents already checks the <code>Content-Type</code> header which usually states what kind of data format the response is. If it is <code>application/json</code> then it automatically converts the json data to a Lua table. Also, it checks the <code>Status</code> header to see if the request was successful. If so, then it sets the <code>ok</code> attribute on the response object. So normally you don’t have to inspect the headers. However, sometimes the web service puts a session token in the response header that you have to use in follow-up requests.

So here an example where we have to log in before we can fetch data. It uses two requests: the first performs the log-in and the second grabs the session token from the login response data and uses that token in the second request to get the data we need. In this example we do this every hour.

That would look like this:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'loggedin', 'data' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/login',
method = 'POST',
postData = { ['username'] = 'Luke Skywalker', ['password'] = 'theforce' }
callback = 'loggedin'
})
end
if (item.isHTTPResponse and item.ok) then
-- check to which request this response was the result
if (item.trigger == 'loggedin') then
-- we are logged in, now grab the session token from the header and
-- fetch our data
local token = item.headers['x-session-token']
-- now we have the token, put it in the headers:
domoticz.openURL({
url = 'https://somedomain.com/getData',
method = 'GET',
headers = { ['x-session-token'] = token },
callback = 'data'
})
else
-- it must the data we requested
local data = item.data
-- do something with it
end
end
end
}</syntaxhighlight>
Some remarks about the response header <code>Content-Type</code>. If a service is a good web-citizen then it tells you what the format of the data is in this header. So, if the data is a json object then the header should be <code>application/json</code>. Unfortunately, there are lot of lazy programmers out there who don’t set this header properly. If that is the case, dzVents cannot detect the format and will not turn it into a Lua table for you automatically. So, if you know it is json but the header is not properly set, then you can easily convert it into a Lua table in your code:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/getData',
callback = 'trigger'
})
end
if (item.isHTTPResponse and item.ok) then
-- we know it is json but dzVents cannot detect this
-- convert to Lua
local json = domoticz.utils.fromJSON(item.data)
-- json is now a Lua table
print(json.result.title) -- just an example
end
end
}</syntaxhighlight>

= Asynchronous shell command execution =

dzVents allows you to make asynchronous shell commands and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use functions like <code>utils.osCommand()</code> or <code>os.Execute()</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz comes with a message that the script took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to execute a shell command asynchronously and it is determined by how you use the <code>domoticz.executeShellCommand()</code> command. The simplest form simply calls <code>executeShellCommand</code> on the domoticz object with only the command as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.executeShellCommand('some shell command')</syntaxhighlight>
After your script is finished, Domoticz will execute the request in a separate thread and that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a command you pass in a table with the command to be executed '''and''' a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.executeShellCommand({
command = 'some shell command',
callback = 'mycallbackstring',
timeout = timeoutinseconds,
})
end
}</syntaxhighlight>
In this case, Domoticz will execute the command and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
shellCommandResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if response.ok then
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every 5 minutes',
},
shellCommandResponses =
{
scriptVar,
},
},

execute = function(domoticz, item)
if item.isTimer then
domoticz.executeShellCommand(
{
command = 'some shell command',
callback = scriptVar,
timeout = timeoutinseconds,
})
elseif item.isShellCommandResponse then
if item.statusCode == 0 then
... -- process result (in item.json, -item.xml, -item.lines or item.data)
end
end
end
}
</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.executeShellCommand(options)''': ''options'' is a Lua table:

* '''command''': ''String''.
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to find a the callback handler script.
* '''timeout''': ''Integer''. Optional. Max execution time in seconds. defaults to 10 seconds. A value of 0 disables the timeout.

Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': output from the command. (stdout)
* '''errorText''': Errors generated by the command (stderr)
* '''statusCode''': ''Int''. exitcode generated by the command
* '''hasLines''': ''Boolean''. When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''json''': ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be 0.
* '''timeoutOccurred''' ''Boolean'' <code>True</code> when the request was aborted by a timeout.
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


= Settings =

Settings for dzVents are found in the Domoticz GUI: '''Setup > Settings > Other > EventSystem''':

* '''dzVents disabled''': Tick this if you don’t want any dzVents script to be executed.
* '''Log level''': (Note that you can override this setting in the logging section of your script)
** ''Errors'',
** ''Errors + minimal execution info'': Errors and some minimal information about which script is being executed and why,
** ''Errors + minimal execution info + generic info''. Even more information about script execution and a bit more log formatting.
** ''Debug''. Shows everything and dzVents will create the files <code>domoticzData.lua</code> and <code>module.log</code> in the scripts/dzVents folder. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz and <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.
** ''No logging''. As silent as possible.


= Troubleshooting =

So, you think if you have done everything correctly but things do not work (in some way) as you expected. Here are a couple steps you can do to find the cause.


=== Is dzVents enabled? ===

Check the settings (see above) and make sure the checkbox '''dzVents disabled''' is not checked.


=== Is your script enabled? ===

Make sure the active section in your script is set to <code>true</code>: <code>active = true</code>. And, on top of that, if you are using the internal web editor to write your script, make sure that your script is active there and you have clicked Save! “Event active” is a separate checkbox that must be ticked for every active script. When not active, the script name will be red in the list on the right.


=== Turn on debug logging ===

Activate debug logging in the settings (see above). This will produce a lot of extra messages in the Domoticz log (don’t forget to turn it off when you are done troubleshooting!). It is best to monitor the log through the command line, as the log in the browser sometimes tends to not always show all log messages. See the Domoticz manual for how to do that.

When debug logging is enabled, every time dzVents kicks into action (Domoticz throws an event) it will log it, and it will create the files <code>domoticzData.lua</code> and <code>module.log</code> in <code>/path/to/domoticz/scripts/dzVents</code>. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz. This data lie at the core of the dzVents object model. You can open this file in an editor to see if your device/variable/scene/group/hardware is in there. Note that the data in the file are not exactly the same as what you will get when you interact with dzVents, but it is a good start. If your object is not in the data file, then you will not have access to it in dzVents and dzVents will not be able to match triggers with that object. Something’s wrong if you expect your object to be in there but it is not (is the object active/used?). <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.with a dump of the data sent to dzVents.

Example content of <code>module.log</code>

<pre> Startdate time - End date time (clk - CPU ) dule / scriptname << type: "trigger"
---------------------------------------------------------------------------------------------------------------
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0029) waqi.lua << timer: "every 20 minutes"
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0016) Washer.lua << timer: "every 5 minutes"
11/27/20 18:40:01 - 11/27/20 18:40:01 (00 - 0.0215) getWaterFromHomewizard.lua << HTTPResponse: "WaterfromHomewizard"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.2472) updateWeatherSensors.lua << HTTPResponse: "WUS_buienradarResponse"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.0290) waqi.lua << HTTPResponse: "waqi_nearby"
11/27/20 18:41:00 - 11/27/20 18:41:00 (00 - 0.0583) Bathroom humidity.lua << timer: "every minute between 05:15 and 23:30"</pre>
Every time Domoticz starts dzVents and debug logging is enabled you should see these lines in the domoticz log:

<pre>dzVents version: x.y.z
Event trigger type: aaaa</pre>
Where aaaa can be time, custom event, system event, device, uservariable, security or scenegroup. That should give you a clue what kind of event is active. If you don’t see this information then dzVents is not active (or debug logging is not active).


=== Script is still not executed ===

If for some reason your script is not executed while all of the above is done, it is possible that your triggers are not correct. Either the time rule is not matching with the current time (try to set the rule to <code>every minute</code> or something simple), or the device name is not correct (check casing), or you use an id that doesn’t exist. Note that in the <code>on</code> section, you cannot use the dzVents domoticz object!

Make sure that if you use an id in the <code>on</code> section that this id is correct. Go to the device list in Domoticz and find the device and make sure the device is in the ‘used’ list!. Unused devices will not create an event. Find the idx for the device and use that as the id.

Also, make sure that your device names are unique! dzVents will throw a warning in the log if multiple device names match. It’s best practice to have unique names for your devices. Use some clever naming like prefixing like ‘Temperature: living room’ or ‘Lights: living room’. That also makes using wild cards on your <code>on</code> section easier.

If your script is still not triggered, you can try to create a classic Lua event script and see if that does work.


=== Debugging your script ===

A simple way to inspect a device in your script is to dump it to the log: <code>myDevice.dump()</code>. This will dump everything known to dzVents of the device so you can inspect what its state is. If you only need to see a subset you can use dumpSelection(‘attributes’), dumpSelection(‘functions’) or dumpSelection(‘tables’) Use print statements or domoticz.log() statements in your script at cricital locations to see if the Lua interpreter reaches that line. Don’t try to print a device object though; use the <code>myDevice.dump()</code> method for that. It wil log all attributes of the device in the Domoticz log.

If you place a print statement all the way at the top of your script file it will be printed every time dzVents loads your script (that is done at the beginning of each event cycle). Sometimes that is handy to see if your script gets loaded in the first place. If you don’t see your print statement in the log, then likely dzVents didn’t load it and it will not work.


=== Get help ===

The Domoticz forum is a great resource for help and solutions. Check the [https://www.domoticz.com/forum/viewforum.php?f=59 dzVents forum].


= Other interesting stuff =


== lodash for Lua ==

lodash is a well known and very popular Javascript library filled with dozens of handy helper functions that really make you life a lot easier. Fortunately there is also a Lua version. This is directly available through the domoticz object:

<syntaxhighlight lang="lua">local _ = domoticz.utils._
_.print(_.indexOf({2, 3, 'x', 4}, 'x'))</syntaxhighlight>

Check out the documentation [https://htmlpreview.github.io/?https://github.com/rwaaren/lodash.lua/blob/master/doc/index.html here].


= History [https://wiki.domoticz.com/DzVents_version_History link to changes in previous versions]. =

See link for the complete list of changes

https://wiki.domoticz.com/DzVents_version_History

DzVents: next generation Lua scripting

2026-08-02T17:01:11Z

Walter vl: /* Variable attributes and methods */

'''Note''': This document is maintained on [https://github.com/domoticz/domoticz/blob/development/dzVents/documentation/README.md github], and the wiki version is automatically generated. Edits should be performed on github, or they may be suggested on the wiki article’s [https://wiki.domoticz.com/Talk:DzVents:_next_generation_Lua_scripting Discussion page]. Editing can be done by any editor but if you are looking for a specialized markDown editor; [https://stackedit.io/app# stackedit.io] would be a good choice.


= About dzVents =

dzVents /diː ziː vɛnts/, short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts. And … '''it is 100% Lua'''! So if you already have a bunch of event scripts for Domoticz, upgrading should be fairly easy.

Let’s start with an example. Say you have a switch that when activated, it should activate another switch but only if the room temperature is above a certain level. And when done, it should send a notification. This is how it looks in dzVents:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'Room switch'}
},

execute = function(domoticz, roomSwitch)
if (roomSwitch.active and domoticz.devices('Living room').temperature > 18) then
domoticz.devices('Another switch').switchOn()
domoticz.notify('This rocks!',
'Turns out that it is getting warm here',
domoticz.PRIORITY_LOW)
end

}</syntaxhighlight>
Or you have a timer script that should be executed every 10 minutes, but only on weekdays, and have it do something with some user variables and only during daytime:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
--activate my scene
domoticz.scenes('Evening lights').switchOn()
if (domoticz.devices('My PIR').lastUpdate.minutesAgo > 5) then
domoticz.devices('Bathroom lights').switchOff()
end
end
end
}</syntaxhighlight>
Or you want to detect a humidity rise within the past 5 minutes:

<syntaxhighlight lang="lua">return
{
on =
{
timer = {'every 5 minutes'}
},
data =
{
previousHumidity = { initial = 100 }
},
execute = function(domoticz)
local bathroomSensor = domoticz.devices('BathroomSensor')
if (bathroomSensor.humidity - domoticz.data.previousHumidity) >= 5 then
-- there was a significant rise
domoticz.devices('Ventilator').switchOn()
end
-- store current value for next cycle
domoticz.data.previousHumidity = bathroomSensor.humidity
end
}</syntaxhighlight>
Just to give you an idea! Everything in your Domoticz system is now logically available in the domoticz object structure. With this domoticz object, you can get to all the information in your system and manipulate your devices.


= Using dzVents with Domoticz =

In Domoticz go to '''Setup > Settings > Other''' and in the section EventSystem make sure the check-box ‘dzVents disabled’ is not checked. Also make sure that in the Security section in the settings '''(Setup > Settings > System > Local Networks (no username/password)''' you allow 127.0.0.1 (and / or ::1 when using IPv6 ) to not need a password. dzVents does use this port to get the location settings and to send certain commands to Domoticz. Finally make sure you have set your current location in '''Setup > Settings > System > Location''', otherwise there is no way to determine nighttime/daytime state.

There are two ways of creating dzVents event scripts in Domoticz:

# By creating scripts in your domoticz instance on your domoticz server: <code>/path/to/domoticz/scripts/dzVents/scripts</code>. Make sure that each script has the extension <code>.lua</code> and follows the guidelines as described below.
# By creating scripts inside Domoticz using the internal Domoticz event editor: Go to '''Setup > More Options > Events'''. Press the + button and choose dzVents. You must then choose a template. They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

'''Note: scripts that you write on the file-system and inside Domoticz using the internal web-editor all share the same name-space. That means that if you have two scripts with the same name, only the one of the file-system will be used. The log will tell you when this happens.'''

'''Note: Scripts created in the internal editor are stored in the domoticz database and are all written to <code>/path/to/domoticz/scripts/dzVents/generated_scripts</code> on every domoticz restart and every “EventSystem: reset all events…”. Scripts in <code>/path/to/domoticz/scripts/dzVents/scripts</code> are not stored in the database and should be backed-up separately. '''


== Quickstart ==

If you made sure that dzVents system is active, we can do a quick test if everything works:

* Pick a switch in your Domoticz system. Write down the exact name of the switch. If you don’t have a switch then you can create a Dummy switch and use that one.
* Create a new file in the <code>/path/to/domoticz/scripts/dzVents/scripts/</code> folder (or using the web-editor in Domoticz, switch to dzVents mode first.). Call the file <code>test.lua</code>. ''Note: when you create a script in the web-editor you do '''not''' add the .lua extension!'' Also, valid script names follow the same rules as [https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words filesystem names].
* Open <code>test.lua</code> in an editor and fill it with this code and change <code><exact name of the switch></code> with the .. you guessed it… exact name of the switch device:

<syntaxhighlight lang="lua"> return {
on = {
devices = {
'<exact name of the switch>'
}
},
execute = function(domoticz, switch)
if (switch.state == 'On') then
domoticz.log('Hey! I am on!')
else
domoticz.log('Hey! I am off!')
end
end
}</syntaxhighlight>
* Save the script
* Open the Domoticz log in the browser
* In Domoticz GUI perhaps in another browser tab) press the switch.
* You can watch the log in Domoticz and it should show you that indeed it triggered your script and you should see the log messages.

See the examples folder <code>/path/to/domoticz/scripts/dzVents/examples</code> for more examples. This folder includes templates you can use to get started as well. And, if you use the GUI web editor to write your script, you will find boilerplate examples in the drop-down below the script type setting.


= Writing scripts =

In order for your scripts to work with dzVents, they have to be turned into a Lua module with a specific structure. Basically you make sure it returns a Lua table (object) with predefined keys like <code>on</code> and <code>execute</code>. Here is an example:

<syntaxhighlight lang="lua">return
{
on =
{
devices = { 'My switch' }
},

execute = function(domoticz, switch)
-- your script logic goes here, something like this:
if (switch.state == 'On') then
domoticz.log('I am on!', domoticz.LOG_INFO)
end
end
}</syntaxhighlight>
Simply said, the <code>on</code>-part defines the trigger and the <code>execute</code> part is what should be done if the trigger matches with the current Domoticz event. So all your logic is inside the <code>execute</code> function.


== Sections in the script ==

Each dzVents event script has this structure:

<syntaxhighlight lang="lua">return
{
active = true, -- optional
on =
{
-- at least one of these:
customEvents = { ... },
devices = { ... },
groups = { ... },
httpResponses = { ... },
scenes = { ... },
security = { ... },
shellCommandResponses = { ... },
system = { ... },
timer = { ... },
variables = { ... },

},
data = { ... }, -- optional
logging = { ... }, -- optional
execute = function(domoticz, item, triggerInfo)
-- your code here
end
}</syntaxhighlight>

=== active = true/false (optional) ===

If <code>active = false</code>, then the script is not activated: ''dzVents will ignore the script completely''. If you don’t have <code>active</code> specified, <code>true</code> is assumed (default value). If you write scripts with Domoticz’ internal script editor then you don’t need this part as the editor has its own way of enabling and disabling scripts.

So, <code>active</code> can either be:

* '''true''': (default) the script file will be processed.
* '''false''': the script file is ignored.
* '''function(domoticz) … end''': A function returning <code>true</code> or <code>false</code>. The function will receive the domoticz object with all the information about your domoticz instance: <code>active = function(domoticz) .... end</code>. For example you could check for a Domoticz variable or switch and prevent the script from being executed. '''However, be aware that for ''every script'' in your scripts folder, this active function will be called, every cycle!! Therefore, it is better to put all your logic in the execute function instead of in the active function.'''


=== on = { … } ===

The <code>on</code> section tells dzVents ''when'' the execute function has to be executed. It holds all the events/'''triggers''' that are monitored by dzVents. If any of the events or triggers match with the current event coming from Domoticz, then the <code>execute</code> part of the script is executed by dzVents. The <code>on</code> section has many kinds of subsections that ''can all be used simultaneously'' :


==== customEvents = { … } 3.0.0 ====

A list of one or more custom event triggers. This eventTrigger can be activate by a json/api call, a MQTT message (when domoticz is setup to listen to such messages on the hardware tab) or by the dzVents internal command domoticz.emitEvent - The name of the custom-event - The name of the custom-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|See time trigger rules]].


===== API =====

<pre>- curl: curl -d "{ 'a':10, 'b':20, 'some':'text', 'sub' : { 'x':10, 'y':20 } }" "http://<domoticzIP:domoticz port>/json.htm?type=command&param=customevent&event=<myCustomEvent>"
- JSON: **< domoticzIP : domoticz port >**/json.htm?type=command&param=customevent&event=<MyEvent>&data=myData
- MQTT simple: {"command":"customevent", "event":"MyEvent","data":"myData"}
- MQTT complex: {"command":"customevent","event":"MyEvent","data":"{\"idx\":29,\"test\":\"ok\"}" }
- emitEvent: domoticz.emitEvent('myCustomEvent' [,])
`domoticz.emitEvent('myEvent') -- no data`
`domoticz.emitEvent('another event', 'some data')`
`domoticz.emitEvent('hugeEvent', { a = 10, b = 20, some = 'text', sub = { x = 10, y = 20 } })`</pre>

===== Attributes =====

The customEvent object (second parameter in your execute function) has these attributes:

* '''data''': Raw customEvent data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''.3.0.3 true when the customEvent data is a valid json string. The data is then automatically converted to a Lua table.
* '''isXML''': ''Boolean''. 3.0.3 true when the customEvent data is a valid xml string. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. 3.0.3 When the customEvent data is a valid json string, the response data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a table for quick and easy access. nil otherwise
* '''trigger''', '''customEvent''': ''String''.3.0.3 The string that triggered this customEvent instance. This is useful if you have a script that can be triggered by multiple different customEvent strings.
* '''xml'''. ''Table''. 3.0.3 When the response data is a valid xml string, the customEvent data is automatically converted to a Lua table for quick and easy access. nil otherwise
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


==== devices = { … } ====

A list of device-names or indexes. If a device in your system was updated (e.g. a switch was triggered or a new temperature was received) and it is listed in this section then the execute function is executed. '''Note''': update does not necessarily means the device state or value has changed. Each device can be:

* The name of your device between string quotes. '''You can use the asterisk (*) wild-card here e.g. <code>PIR_*</code> or <code>*_PIR</code>'''. E.g.: <code>devices = { 'myDevice', 'anotherDevice', 123, 'pir*' }</code>
* The index (idx) of your device (as the name may change, the index will usually stay the same, the index can be found in the devices section in Domoticz). '''Note that idx is a number;'''
* The name or idx of your device followed by a time constraint, such as: <code>['myDevice'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if <code>myDevice</code> was changed, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].


==== groups = { …} ====

A list of one or more group-names or indexes. The same rules as devices apply.


==== httpResponses = { …} ====

A list of one or more http callback triggers. Use this in conjunction with <code>domoticz.openURL()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


==== shellCommandResponses = { …} 3.1.0 ====

A list of one or more scriptcommand callback triggers. Use this in conjunction with <code>domoticz.executeShellCommand()</code> where you will provide Domoticz with the callback trigger. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.


==== scenes = { … } ====

A list of one or more scene-names or indexes. The same rules as devices apply. So if your scene is listed in this table then the executed function will be triggered, e.g.: <code>on = { scenes = { 'myScene', 'anotherScene' } },</code>.


==== security = { … } ====

A list of one or more of these security states:

* <code>domoticz.SECURITY_ARMEDAWAY</code>,
* <code>domoticz.SECURITY_ARMEDHOME</code>,
* <code>domoticz.SECURITY_DISARMED</code>

If the security state in Domoticz changes and it matches with any of the states listed here, the script will be executed. See <code>/path/to/domoticz/scripts/dzVents/examples/templates/security.lua</code> for an example see [[#Security_Panel|Security Panel]] for information about how to create a security panel device.


==== system = { …} 3.0.0 ====

A list of one or more system triggers.

* <code>stop</code>, <code>start</code>, <code>manualBackupFinished</code>, <code>dailyBackupFinished</code>, <code>hourlyBackupFinished</code>, <code>monthlyBackupFinished</code>, <code>resetAllDeviceStatus</code>, 3.1.5 <code>resetAllEvents</code>, 3.1.5
* The name of the system-event followed by a time constraint, such as: <code>['start'] = { 'at 15:*', 'at 22:* on sat, sun' }</code> The script will be executed if domoticz is started, '''and''' it is either between 15:00 and 16:00 or between 22:00 and 23:00 in the weekend. See [[#timer_trigger_rules|time trigger rules]].
** '''start''' - fired when Domoticz has started.
** '''stop''' - fired when Domoticz is shutting down. As you probably can imagine you have only a limited amount of time - also depending on the load on your system - to have Domoticz do stuff when your script has been completed. Some commands will probably not be executed. Just give it a try.
** '''Backups''' - the trigger item (2nd parameter of the execute function) is a table that holds information about the newly created backup (location, duration in seconds and type). You could use this information to copy the file to some other location or for another purpose.
*** '''dailyBackupFinished''' - automatic backup when set in domoticz
*** '''hourlyBackupFinished''' - ” ”
*** '''monthlyBackupFinished''' - ” ”
*** '''manualBackupFinished''' - fired when you start a backup using the Domoticz GUI or via '''< domoticz IP:domoticz port >'''/backupdatabase.php
*** '''resetAllDeviceStatus''' 3.1.5- fired when the name, description or used / unused state of a device, variable or scene is updated.
*** '''resetAllEvents''' 3.1.5- fired when a dzVents script in the internal editor changed.


==== timer = { … } ====

A list of one ore more time ‘rules’ like <code>every minute</code> or <code>at 17:*</code>. See [[#timer_trigger_rules|''timer'' trigger rules]]. If any or the rules matches with the current time/date then your execute function is called. E.g.: <code>on = { timer = { 'between 30 minutes before sunset and 30 minutes after sunrise' } }</code>.


==== variables = { … } ====

A list of one or more user variable-names as defined in Domoticz ( ''Setup > More options > User variables''). If any of the variables listed here is updated, ( '''Note''': update does not necessarily means the variable value or type changed ).the script is executed. '''Note''': Script will only execute when this variable is updated directly by dzVents or by a JSON. If updated with a standard Lua script (using commandArray) or in combination with a time option like afterAAA no event will be triggered.


=== execute = function('''domoticz, item, triggerInfo''') … end ===

When all the above conditions are met (active == true and the on section has at least one matching rule), then this <code>execute</code> function is called. This is the heart of your script. The function has three parameters:


==== 1. ('''domoticz''', item, triggerInfo) ====

The [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]]. This object gives you access to almost everything in your Domoticz system, including all methods to manipulate them—like modifying switches or sending notifications. More about the [[#Domoticz_object_API_.28Application_Programming_Interface.29|domoticz object]] below.


==== 2. (domoticz, '''item''', triggerInfo) ====

Depending on what actually triggered the script, <code>item</code> is either a:

* [[#Custom_event_API|customEvent]] 3.0.0
* [[#Device_object_API|device]],
* [[#Variable_object_API_.28user_variables.29|variable]],
* [[#Scene|scene]],
* [[#Group|group]],
* [[#timer_=_%7B_..._%7D|timer]],
* [[#System_event_API|system]], 3.0.0
* [[#Security_Panel|security]] or
* [[#Asynchronous_HTTP_requests|httpResponse]]
* [[#Asynchronous_shell_command_executio|shellCommandResponse]] 3.1.0

Since you can define multiple on-triggers in your script, it is not always clear what the type is of this second parameter. In your code you need to know this in order to properly respond to the different events. To help you inspect the object you can use these attributes like <code>if (item.isDevice) then ... end</code>:

* '''isCustomEvent''': 3.0.0. returns <code>true</code> if the item is a customEvent object.
* '''isDevice''': . returns <code>true</code> if the item is a Device object.
* '''isGroup''': . returns <code>true</code> if the item is a Group object.
* '''isHTTPResponse''': . returns <code>true</code> if the item is an HTTPResponse object.
* '''isShellCommandResponse''': . 3.1.0 returns <code>true</code> if the item is a shellcommandResponse object.
* '''isScene''': . returns <code>true</code> if the item is a Scene object.
* '''isSecurity''': . returns <code>true</code> if the item is a Security object.
* '''isSystemEvent''': 3.0.0. returns <code>true</code> if the item is a system object.
* '''isTimer''': . returns <code>true</code> if the item is a Timer object.
* '''isVariable''': . returns <code>true</code> if the item is a Variable object.
* '''trigger''': . ''string''. the timer rule, the security state, the customEvent or the http response callback string that actually triggered your script. E.g. if you have multiple timer rules can inspect <code>trigger</code> which exact timer rule was fired.


==== 3. (domoticz, item, '''triggerInfo''') ====

'''Note''': as of version 2.4.0, <code>triggerInfo</code> has become more or less obsolete and is left in here for backward compatibility. All information is now available on the <code>item</code> parameter (second parameter of the execute function, see point 2 above).

<code>triggerInfo</code> holds information about what triggered the script. The object has two attributes:

# '''type''': the type of the the event that triggered the execute function, either: - domoticz.EVENT_TYPE_CUSTOM,3.0.0 - domoticz.EVENT_TYPE_DEVICE, - domoticz.EVENT_TYPE_GROUP - domoticz.EVENT_TYPE_HTTPRESPONSE - domoticz.EVENT_TYPE_SCENE, - domoticz.EVENT_TYPE_SECURITY, - domoticz.EVENT_TYPE_SYSTEM,3.0.0 - domoticz.EVENT_TYPE_TIMER, - domoticz.EVENT_TYPE_VARIABLE)
# '''trigger''': the timer rule that triggered the script if the script was called due to a timer event, or the security state that triggered the security trigger rule. See [[#timer_trigger_rules|below]] for the possible timer trigger rules.
# '''scriptName''': the name of the current script.


==== Tip: rename the parameters to better fit your needs ====

The names of the execute parameters are actually something you can change to your convenience. For instance, if you only have one trigger for a specific switch device, you can rename <code>item</code> it to <code>switch</code>. Or if you think <code>domoticz</code> is too long you can rename it to <code>d</code> or <code>dz</code> (might save you a lot of typing and may make your code more readable):

<syntaxhighlight lang="lua">return
{
on =
{
devices = 'mySwitch'
},
execute = function(dz, mySwitch)
dz.log(mySwitch.state, dz.LOG_INFO)
end
}</syntaxhighlight>

=== data = { … } (optional) ===

The optional data section allows you to define local variables that will hold their values ''between'' script runs. These variables can get a value in your execute function and the next time the script is executed these variables will have their previous state restored. For more information see the section [[#Persistent_data|Persistent data]].


=== logging = { … } (optional) ===

The optional logging section allows you to override the global logging setting of dzVents as set in ''Setup > Settings > Other > EventSystem > dzVents Log Level''. This can be handy when you only want this script to have extensive debug logging while the rest of your script executes silently. You have these options:

* '''level''': This is the minimum log level you want for this script. This can be domoticz.LOG_INFO, domoticz.LOG_STATUS, domoticz.LOG_ERROR or domoticz.LOG_DEBUG
* '''marker''': A string that is prefixed before each log message. That way you can easily create a filter in the Domoticz log to see just these messages. '''marker''' defaults to scriptname

\*LOG_DEBUG will also cause Execution Info to be displayed (start/finished)

Example:

<syntaxhighlight lang="lua">logging = {
level = domoticz.LOG_DEBUG,
marker = "Hey you"
},</syntaxhighlight>

== Some trigger examples ==


=== Custom events ===

Suppose you want to trigger a script not on the minute but 30 seconds later.

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every minute',
},

customEvents =
{
'delayed',
},
},
execute = function(domoticz, item)
if item.isTimer then
domoticz.emitEvent('delayed', domoticz.time.rawTime ).afterSec(30)
else
domoticz.notify('Delayed', 'Event was emitted at ' .. item.data, domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Device changes ===

Suppose you have two devices—a smoke detector ‘myDetector’ and a room temperature sensor ‘roomTemp’, and you want to send a notification when either the detector detects smoke or the temperature is too high:

<syntaxhighlight lang="lua">return
{
on =
{
devices = {
'myDetector',
'roomTemp'
}
},
execute = function(domoticz, device)
if ((device.name == 'myDetector' and device.active) or
(device.name == 'roomTemp' and device.temperature >= 45)) then
domoticz.notify('Fire', 'The room is on fire', domoticz.PRIORITY_EMERGENCY)
end
end
}</syntaxhighlight>

=== Scene / group changes ===

Suppose you have a scene ‘myScene’ and a group ‘myGroup’, and you want to turn on the group as soon as myScene is activated:

<syntaxhighlight lang="lua">return {
on = {
scenes = { 'myScene' }
},
execute = function(domoticz, scene)
if (scene.state == 'On') then
domoticz.groups('myGroup').switchOn()
end
end
}</syntaxhighlight>
Or, if you want to send an email when a group is activated at night:

<syntaxhighlight lang="lua">return {
on = {
groups = { ['myGroup'] = {'at nighttime'} }
},
execute = function(domoticz, group)
if (group.state == 'On') then
domoticz.email('Hey', 'The group is on', 'someone@the.world.org')
end
end
}</syntaxhighlight>

=== Timer events ===

Suppose you want to check the soil humidity every 30 minutes during the day and every hour during the night:

<syntaxhighlight lang="lua">return {
on = {
timer = {
'every 30 minutes at daytime',
'every 60 minutes at nighttime'
}
},
execute = function(domoticz, timer)
domoticz.log('The rule that triggered the event was: ' .. timer.trigger')
if (domoticz.devices('soil').moisture > 100) then
domoticz.devices('irrigation').switchOn().forMin(60)
end
end
}</syntaxhighlight>

=== Variable changes ===

Suppose you have a script that updates a variable ‘myAmountOfMoney’, and if that variable reaches a certain level you want to be notified:

<syntaxhighlight lang="lua">return
{
on =
{
variables = { 'myAmountOfMoney' }
},
execute = function(domoticz, variable)
-- variable is the variable that's triggered
if (variable.value > 1000000) then
domoticz.notify('Rich', 'You can stop working now', domoticz.PRIORITY_HIGH)
end
end
}</syntaxhighlight>

=== Security changes ===

Suppose you have a group holding all the lights in your house, and you want to switch it off as soon as the alarm is activated:

<syntaxhighlight lang="lua">return
{
on =
{
security = { domoticz.SECURITY_ARMEDAWAY }
},
execute = function(domoticz, security)
domoticz.groups('All lights').switchOff()
end
}</syntaxhighlight>

=== Asynchronous HTTP Request and handling ===

Suppose you have some external web service that will tell you what the current energy consumption is and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
httpResponses = { 'energyRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = 'http://url/to/service',
method = 'GET',
callback = 'energyRetrieved'
})
elseif (item.isHTTPResponse) then
if (item.ok) then -- statusCode == 2xx
local current = item.json.consumption
domoticz.devices('myCurrentUsage').updateEnergy(current)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_HTTP_requests|asynchronous http requests]] for more information.


=== Asynchronous shell command execution 3.1.0 ===

Suppose you have some local shellcommand to measure the speed of your internet connection and you want that information in Domoticz:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
shellCommandResponses = { 'internetspeedRetrieved' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.executeShellCommand({
command = 'speedtest-cli --json', -- just an example
callback = 'internetspeedRetrieved', -- see shellCommandResponses above.
timeout = 20, -- max execution time in seconds
})
elseif (item.isShellCommandResponse) then
if (item.statusCode==0) then
domoticz.devices('myCurrentdownloadspeed').updateCustomSensor(item.json.download)
end
end
end
}</syntaxhighlight>
See[[#Asynchronous_shell_command_execution|asynchronous shell commands]] for more information.


=== System changes ===

Do some initial work when domoticz starts

<syntaxhighlight lang="lua">return
{
on =
{
system =
{
'start',
'backupDoneDaily',
},

},

execute = function(domoticz, system)
domoticz.log('Domoticz sends ' .. system.type, domoticz.LOG_INFO)

if system.type == 'start' then
domoticz.device('initial device').switchOff().silent
domoticz.variables('special startVar').set('domoticz started at ' .. domoticz.time.rawDateTime )
elseif system.type == 'backupDoneDaily' then
domoticz.notify('Domoticz backup', 'Ended. Backupfile ' .. system.data.location , domoticz.PRIORITY_LOW)
end
end
}</syntaxhighlight>

=== Combined rules ===

Let’s say you have a script that checks the status of a lamp and is triggered by motion detector:

<syntaxhighlight lang="lua">return {
on = {
timer = { 'every 5 minutes' },
devices = { 'myDetector' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- the timer was triggered
domoticz.devices('myLamp').switchOff()
elseif (item.isDevice and item.active) then
-- it must be the detector
domoticz.devices('myLamp').switchOn()
end
end
}</syntaxhighlight>

=== At startup trigger ===

You can add <code>at_startup = true</code> to the <code>on</code> section to have your script execute once when Domoticz starts, in addition to any other triggers. This is useful when combined with interval-based rules to avoid waiting for the first interval to pass:

<syntaxhighlight lang="lua">return {
on = {
at_startup = true,
timer = { 'every hour' },
},
execute = function(domoticz, item)
-- Runs immediately when Domoticz starts, then every hour
domoticz.devices('myThermostat').setPoint(21)
end
}</syntaxhighlight>
The <code>at_startup</code> trigger fires on the first timer tick after Domoticz starts (within 2 minutes of startup). It can be combined with any other trigger types (timer, devices, httpResponses, etc.).

'''Note:''' This is different from <code>system = { 'start' }</code> which is a system event trigger. <code>at_startup</code> is simpler - just add the flag and your existing script will also run at startup without needing to check <code>item.isSystemEvent</code>.


== ''timer'' trigger rules ==

There are several options for time triggers. It is important to know that Domoticz timer events only trigger once every minute, so one minute is the smallest interval for your timer scripts. However, dzVents gives you many options to have full control over when and how often your timer scripts are called (all times are in 24hr format and all dates in dd/mm): Keywords recognized are “at, between, every, except, in, on, or” ( except supported from version 3.0.16, or supported from version 3.1.8 ).

At every place you read <astroMoment> you can use one of: sunset, sunrise, solarnoon, midnight '', sunatsouth '', civiltwilightstart, civiltwilightend, astronomicaltwilightstart '', astronomicaltwilightend '', nauticaltwilightstart * or nauticaltwilightend *.

Full daynames are allowed in dzVents >= 3.1.7

* 3.1.16

<syntaxhighlight lang="lua"> on = {
timer = {
'every minute', -- causes the script to be called every minute
'every other minute', -- minutes: xx:00, xx:02, xx:04, ..., xx:58
'every <xx> minutes', -- starting from xx:00 triggers every xx minutes
-- (0 > xx < 60)
'every hour', -- 00:00, 01:00, ..., 23:00 (24x per 24hrs)
'every other hour', -- 00:00, 02:00, ..., 22:00 (12x per 24hrs)
'every <xx> hours', -- starting from 00:00, triggers every xx
-- hours (0 > xx < 24)
'at 13:45', -- specific time
'at *:45', -- every 45th minute in the hour
'at 15:*', -- every minute between 15:00 and 16:00
'at 12:45-21:15', -- between 12:45 and 21:15. You cannot use '*'!
'at 19:30-08:20', -- between 19:30 and 8:20 (next day)
'at 13:45 on mon,tue', -- at 13:45 only on Mondays and Tuesdays (english)
'on mon,tue', -- on Mondays and Tuesdays
'every hour on Saturday', -- you guessed it correctly
'at sunset', -- uses sunset/sunrise/solarnoon info from Domoticz
'at sunrise',
'at <astroMoment>', -- dzVents >= 3.0.16 Uses the times received from Domoticz
'at <astroMoment> on sat,sun',
'xx minutes before <astroMoment>', --
'xx minutes after <astroMoment>', -- Please note that these relative times will cross dates
'between aa and bb' -- aa/bb can be a time stamp like 15:44 (if aa > bb will cross dates)
-- aa/bb can be sunrise/sunset/solarnoon ('between sunset and sunrise' and 'between solarnoon and sunrise' will cross dates)
-- aa/bb can be 'xx minutes before/after <astroMoment>'
'at <astroRange>', -- between <astroMoment>start and <astroMoment>end
'at nighttime', -- between sunset and sunrise
'at daytime', -- between sunrise and sunset
'at daytime on mon,tue', -- between sunrise and sunset only on Mondays and Tuesdays
'in week 1-7,44' -- in week 1-7 or 44
'in week 20-25,33-47' -- between week 20 and 25 or week 33 and 47
'in week -12, 33-' -- week <= 12 or week >= 33
'every odd week',
'every even week', -- odd or even numbered weeks
'on 23/11', -- on 23rd of November (dd/mm)
'on 23/11-25/12', -- between 23/11 and 25/12
'on 2/3-8/3,7/8,6/10-14/10',-- between march 2 and 8, on august 7 and between October 6 and 14.
'on */2,15/*', -- every day in February or
-- every 15th day of the month
'on -3/4,4/7-', -- before 3/4 or after 4/7

'at 12:45-21:15 except at 18:00-18:30', -- between 12:45 and 21:15 but not between 18:00 and 18:30 ( except supported from 3.0.16 onwards )
'at daytime except on sun', -- between sunrise and sunset but not on Sundays
'at daytime or at 23:12', -- between sunrise and sunset and also at 23:12

-- or if you want to go really wild and combine them:
'at nighttime at 21:32-05:44 every 5 minutes on sat, sun except at 04:00', -- except supported from 3.0.16 onwards
'every 10 minutes between 20 minutes before sunset and 30 minutes after sunrise on mon,fri,tue on 20/5-18/8'

-- or just do it yourself:
function(domoticz)
-- you can use domoticz.time to get the current time
-- note that this function is called every minute!
-- custom code that either returns true or false
...
end
},
}</syntaxhighlight>
The timer events are triggered every minute. If such a trigger occurs, dzVents will scan all timer-based events and will evaluate the timer rules. So, if you have a rule <code>on mon</code> then the script will be executed ''every minute'' but only on Monday.

Be mindful of the logic if using multiple types of timer triggers. It may not make sense to combine a trigger for a specific or instantaneous time with a trigger for a span or sequence of times (like ‘at sunset’ with ‘every 6 minutes’) in the same construct. Similarly, <code>'between aa and bb'</code> only makes sense with instantaneous times for <code>aa</code> and <code>bb</code>.

'''One important note: if Domoticz, for whatever reason, skips a timer event then you may miss the trigger! Therefore, you should build in some fail-safe checks or some redundancy if you have critical time-based stuff to control. There is nothing dzVents can do about it'''

'''Tip:''' If you want your timer script to also run at Domoticz startup (instead of waiting for the first timer match), add <code>at_startup = true</code> to your <code>on</code> section. See [[#at-startup-trigger|At startup trigger]].

Another important issue: the way it is implemented right now, the <code>every xx minutes</code> and <code>every xx hours</code> is a bit limited. The interval resets at every *:00 (for minutes) or 00:* for hours. You need an interval that is an integer divider of 60 (or 24 for the hours). So you can do every 1, 2, 3, 4, 5, 6, 10, 12, 15, 20 and 30 minutes only.


= The domoticz object =

The domoticz object passed as the first parameter to the <code>execute</code> function contains everything you need to interact with your domotica system. It provides all information made available by the domoticz event system about your custom- and system events, devices, scenes, groups, hardware modules and variables and has methods needed to inspect and manipulate them. Getting this information is easy:

<code>domoticz.time.isDayTime</code> or <code>domoticz.devices('My sensor').temperature</code> or <code>domoticz.devices('My sensor').lastUpdate.minutesAgo</code>.

The domoticz object consists of a logically arranges structure. It harbors all methods to manipulate Domoticz. dzVents will take care to notify Domoticz with all your intended changes and actions. Earlier you had to fill a commandArray with obscure commands. That’s no longer the case.

Some more examples: <code>domoticz.devices(123).switchOn().forMin(5).afterSec(10)</code> or <code>domoticz.devices('My dummy sensor').updateBarometer(1034, domoticz.BARO_THUNDERSTORM)</code>.

One tip before you get started: '''Make sure that all your devices have unique names. dzVents will give you warnings in the logs if device names are not unique.'''


== Domoticz object API (Application Programming Interface) ==

The domoticz object holds all information about your Domoticz system. It has global attributes and methods to query and manipulate your system. It also has a collection of '''devices''', '''variables''' (user variables in Domoticz), '''scenes''', '''groups''', '''hardware'''. Each of these collections has four iterator functions: <code>find(), forEach()</code>, <code>filter()</code> and <code>reduce()</code> to make searching for devices easier. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]].


=== Domoticz attributes and methods ===

* '''devices(idx/name)''': ''Function''. A function returning a device by idx or name: <code>domoticz.devices(123)</code> or <code>domoticz.devices('My switch')</code>. For the device API see [[#Device_object_API|Device object API]]. To iterate over all devices do: <code>domoticz.devices().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.devices()) do .. end</code>.
* '''dump([osfile]3.0.0)''': ''Function''. Dump all domoticz.settings attributes to the Domoticz log. This ignores the log level setting.
* '''email(subject, message, mailTo [, delay]3.0.10)''': ''Function''. Send email. Optional parm delay is delay in seconds.
* '''emitEvent(name,[extra data ])''':''Function''. 3.0.0 Have Domoticz ‘call’ a customEvent. If you just pass a name then Domoticz will execute the script(s) that subscribed to the named customEvent after your script has finished. You can optionally pass extra information as a string or table. A table will be automatically converted into a json string and converted back to a table in the subscribed script(s). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''executeShellCommand(command/options)''': ''Function''. 3.1.0 Have Domoticz ‘call’ a command. If you just pass a command then Domoticz will execute the command after your script has finished but you will not get notified. If you pass options table with a callback then you have the possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_shell_command_execution|asynchronous shell commands]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. '''Note Make sure that when you use this function on a Windows system and use one or more of the special chars &<>()@^| outside double quotes, you will have to escape these with a ^ char '''
* '''groups(idx/name)''': ''Function'': A function returning a group by name or idx. Each group has the same interface as a device. To iterate over all groups do: <code>domoticz.groups().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.groups()) do .. end</code>. Read more about [[#Group|Groups]].
* '''hardwareInfo(idx/name)''': 3.0.6 ''Function'': A function returning hardwareInfo of a hardware module by name or idx. The return of the function is a table with attributes name, type, typeValue, deviceNames (table with names of all active devices defined on this hardware) and deviceIds (table with idx of all active devices defined on this hardware)
* '''hardware(idx/name)''': 3.0.7 ''Function'': A function returning a hardware module by name or idx. Each hardware has an interface comparable to group. To iterate over all hardware do: <code>domoticz.hardware().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that you cannot do <code>for i, j in pairs(domoticz.hardware()) do .. end</code>. Read more about [[#Hardware|Hardware]].
* '''helpers''': ''Table''. Collection of shared helper functions available to all your dzVents scripts. See [[#Shared_helper_functions|Shared helper functions]].
* '''log(message, [level])''': ''Function''. Creates a log entry in the Domoticz log but respects the log minimum level settings. You can provide the loglevel: <code>domoticz.LOG_INFO</code>, <code>domoticz.LOG_STATUS</code>, <code>domoticz.LOG_ERROR</code>, <code>domoticz.LOG_DEBUG</code> or <code>domoticz.LOG_FORCE</code>. In Domoticz settings you can set the default log level for dzVents.
* '''moduleLabel''': 3.0.3 Module (script) name without extension.
* '''notify(subject, message [,priority][,sound][,extra][,subsystem][,delay]3.0.10 )''': ''Function''. Send a notification (like Prowl). Priority can be like <code>domoticz.PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY</code>. <code>extra</code> is notification subsystem specific. For NSS_FIREBASE you can use this field to specify the target mobile (‘midx_1’, midx_2, etc..) or specify <code>device.id</code> so the receiver knows which device triggered the notification. For sound see [[#Constants|list of dzVents Constants]] for the SOUND constants below. <code>subsystem</code> defaults to all subsystems but can be one subsystem or a table containing one or more notification subsystems. See [[#Constants|list of dzVents Constants]] for <code>domoticz.NSS_subsystem</code> types. Delay is delay in seconds
* '''openURL(url/options)''': ''Function''. Have Domoticz ‘call’ a URL. If you just pass a url then Domoticz will execute the url after your script has finished but you will not get notified. If you pass a table with options then you have to possibility to receive the results of the request in a dzVents script. Read more about [[#Asynchronous_HTTP_requests|asynchronous http requests]] with dzVents. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''scenes(idx/name)''': ''Function'': A function returning a scene by name or id. Each scene has the same interface as a device. See [[#Device_object_API|Device object API]]. To iterate over all scenes do: <code>domoticz.scenes().forEach(..)</code>. See [[#looping-through-the-collections-iterators|Looping through the collections: iterators]]. (#Looping_through_the_collections:_iterators). Note that you cannot do <code>for i, j in pairs(domoticz.scenes()) do .. end</code>. Read more about [[#Scene|Scenes]].
* '''security''': Holds the state of the security system e.g. <code>Armed Home</code> or <code>Armed Away</code>.
* '''sendCommand(command, value[, delay] 3.0.10)''': Generic (low-level)command method (adds it to the commandArray) to the list of commands that are being sent back to domoticz. Optional parm delay is delay in seconds ''There is likely no need to use this directly. Use any of the device methods instead (see below).''
* '''settings''':
** '''domoticzVersion''': domoticz version string.
** '''dzVentsVersion''': dzVents version string.
** '''location'''
*** '''latitude''': domoticz settings locations latitude.
*** '''longitude''': domoticz settings locations longitude.
*** '''name''': domoticz settings location Name.
** '''secureServer''': ''boolean'' 3.1.1 true when domoticz can be accessed via https.
** '''serverPort''': webserver listening port used by dzVents to access domoticz API.
** '''url''': internal url to access the API service.
** '''webRoot''': <code>webroot</code> 3.1.1 value as specified when starting the Domoticz service (or default).
** '''wwwBind''': <code>wwwbind</code> 3.1.4 value as specified when starting the Domoticz service (or default).
* '''sms(message [, delay] 3.0.10 )''': ''Function''. Sends an sms if it is configured in Domoticz. Optional parm delay is delay in seconds.
* '''snapshot(cameraID(s) or camera Name(s)3.0.13,subject)''': ''Function''. Sends email with a camera snapshots if email is configured and set for attachments in Domoticz. Send 1 or multiple camerIDs -names in ; separated string or array.

<syntaxhighlight lang="lua"> dz.snapshot() -- defaults to id = 1, subject domoticz
dz.snapshot(1,'dz') -- subject dz
dz.snapshot('1;2;3') -- ; separated string
dz.snapshot({1,4,7}) -- table
dz.snapshot('test;test2') -- ; separated string
dz.snapshot({'test', 'test2'}) -- table</syntaxhighlight>
<ul>
<li>'''switchTimerPlan(idx)''': ''Function''. Switch the active timer plan to the plan with the given database ID. <code>idx</code> must be a positive integer matching an existing timer plan ID (as shown in '''Settings → Timer Plans'''). Invalid or non-existent plan IDs are silently ignored. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''startTime''': ''[[#Time_object|Time Object]]''. Returns the startup time of the Domoticz service.</li>
<li>'''systemUptime''': ''Number''. Number of seconds the system is up.</li>
<li>'''time''': ''[[#Time_object|Time Object]]'': Current system time. Additional to Time object attributes:
<ul>
<li>'''isDayTime''': ''Boolean''</li>
<li>'''isNightTime''': ''Boolean''</li>
<li>'''isCivilDayTime''': ''Boolean''.</li>
<li>'''isCivilNightTime''': ''Boolean''.</li>
<li>'''isToday''': ''Boolean''. Indicates if the device was updated today</li>
<li>'''sunriseInMinutes''': ''Number''. Number of minutes since midnight when the sun will rise.</li>
<li>'''sunsetInMinutes''': ''Number''. Number of minutes since midnight when the sun will set.</li>
<li>'''civTwilightStartInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will start.</li>
<li>'''civTwilightEndInMinutes''': ''Number''. Number of minutes since midnight when the civil twilight will end.</li></ul></li>
<li>'''triggerHTTPResponse([httpResponse], [delay], [message])''': ''Function''. Creates a callback by sending a logmessage. httpResponse defaults to scriptname, delay defaults to 0 (immediate), message defaults to httpResponse. Left in for backward compatibility only. You can use emitEvent / customEvents now.</li>
<li>'''triggerIFTTT(makerName [,sValue1, sValue2, sValue3])''': ''Function''. Have Domoticz ‘call’ an IFTTT maker event. makerName is required, 0-3 sValue’s are optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''utils''': . A subset of handy utilities: Note that these functions must be preceded by domoticz.utils. If you use more then a few declare something like local _u = domoticz.utils at the beginning of your script and use _u.functionName in the remainder. Example:
<syntaxhighlight lang="lua"> _u = domoticz.utils
print(_u.rightPad('test',10) .. '|||') -- => test |||</syntaxhighlight>
<ul>
<li>'''_.lodashFunctions''': This is an entire collection with very handy Luafunctions. Read more about [[#lodash_for_Lua|lodash]]. E.g.: <code>{.lua} domoticz.utils._.size({'abc', 'def'}))` Returns 2.</code></li>
<li>'''cameraExists(parm)''': ''Function'': returns name when entered with a valid camera 3.0.12 or cameraID and return ID when entered with valid cameraName or false when not a camera, cameraID or cameraName of an existing camera</li>
<li>'''deviceExists(parm)''': ''Function'': returns name when entered with a valid device 3.0.12 or deviceID and returns ID when entered with valid deviceName or false when not a device, deviceID or deviceName of an existing (and active) device. Example:
<syntaxhighlight lang="lua">local dz = domoticz
local _u = dz.utils
if _u.deviceExists('myDevice') then
dz.devices('myDevice').switchOn()
else
dz.log('Device myDevice does not exist!', dz.LOG_ERROR)
end

local myName = _u.deviceExists(123)
if myName then
dz.log('Device 123 is ' .. myName, dz.LOG_INFO)
else
dz.log('Device 123 does not exist', dz.LOG_ERROR)
end</syntaxhighlight></li>
<li>'''dumpTable(table,[levelIndicator],[osfile]3.0.0))''': ''Function'': print table structure and contents to log</li>
<li>'''fileExists(path)''': ''Function'': Returns <code>true</code> if the file (with full path) exists.</li>
<li>'''fromBase64(string)''': ''Function'': Decode a base64 string</li>
<li>'''fromJSON(json, fallback, deSerialize 3.1.8 )''': ''Function''. Turns a json string to a Lua table. Example: <code>local t = domoticz.utils.fromJSON('{ "a": 1 }')</code>. Followed by: <code>print( t.a )</code> will print 1. Optional 2nd param fallback will be returned if json is nil or invalid. Optional 3rd param deSerialize (boolean) determines if the JSON should be deserialized before converting.</li>
<li>'''fromXML(xml, fallback )''': ''Function'': Turns a xml string to a Lua table. Example: <code>local t = domoticz.utils.fromXML('<testtag>What a nice feature!</testtag>') Followed by:</code>print( t.texttag)` will print What a nice feature! Optional 2nd param fallback will be returned if xml is nil or invalid.</li>
<li>'''fuzzyLookup([string|array of strings], parm)''': ''Function'': 3.0.14. Search fuzzy matching string in parm. If parm is string it returns a number (lower is better match). If parm is array of strings it returns the best matching string.</li>
<li>'''groupExists(parm)''': ''Function'': returns name when entered with a valid group 3.0.12 or groupID and return ID when entered with valid groupName or false when not a group, groupID or groupName of an existing group</li>
<li>'''hardwareExists(parm)''': ''Function'': 3.0.7 returns name when entered with valid hardwareID or ID when entered with valid hardwareName or false when not a hardwareID or hardwareName of an existing (and active )hardware module</li>
<li>'''inTable(table, searchString)''': ''Function'': Returns <code>"key"</code> if table has searchString as a key, <code>"value"</code> if table has searchString as value and <code>false</code> otherwise.</li>
<li>'''isJSON(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘application/json’ or string is enclosed in {} and <code>false</code> otherwise.</li>
<li>'''isXML(string[, content])''': ''Function'': 3.0.4 Returns <code>true</code> if content is ‘text/xml’ or ‘application/xml’ or string is enclosed in <> and <code>false</code> otherwise.</li>
<li>'''leftPad(string, length [, character])''': ''Function'': Precede string with given character(s) (default = space) to given length.</li>
<li>'''centerPad(string, length [, character])''': ''Function'': Center string by preceding and succeeding with given character(s) (default = space) to given length.</li>
<li>'''numDecimals(number [, integer [, decimals ]])''': ''Function'': Format number to float representation. ''Examples:''</li></ul>

<syntaxhighlight lang="lua"> domoticz.utils.numDecimals(12.23, 4, 4) -- => 12.2300,
domoticz.utils.numDecimals (12.23,1,1) -- => 12.2,
domoticz.utils.leadingZeros(domoticz.utils.numDecimals (12.23,4,4),9) -- => 0012.2300</syntaxhighlight>
<ul>
<li>'''osCommand(cmd)''': ''Function'': 3.0.13 Execute an OS command and return result and returncode. Note: For long running scripts <code>domoticz.executeShellCommand()</code> should be used, See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''osExecute(cmd)''': ''Function'': Execute an OS command (no return). Note: For long running scripts <code>executeShellCommand()</code> should be used. See [[#Asynchronous_shell_command_execution|Asynchronous shell commands]] for more information.</li>
<li>'''rightPad(string, length [, character])''': ''Function'': Succeed string with given character(s) (default = space) to given length.</li>
<li>'''round(number, [decimalPlaces])''': ''Function''. Helper function to round numbers. Default decimalPlaces is 0.</li>
<li>'''sceneExists(parm)''': ''Function'': returns name when entered with valid scene 3.0.12 or sceneID and return ID when entered with valid sceneName or false when not a scene, sceneID or sceneName of an existing scene</li>
<li>'''setLogMarker([marker])''': ''Function'': set logMarker to ‘marker’. Defaults to scriptname. Can be used to change logMarker based on flow in script</li>
<li>'''splitLine(string , splitOnWord ) 3.1.8)''':''Function''. Helper function to split a line. Return is a table with line-segments.</li>
<li>'''stringSplit(string [,separator ] [,convertNumber ][,convertNil ]3.0.17)''':''Function''. Helper function to split a line in separate words. Default separator is space. Return is a table with separated words. Default convertNumber is false when set to true it will convert strings to number where possible. Word is ignored when nil, unless convertNil is set; in that case word will be set to the convertNil value.</li>
<li>'''stringToSeconds(str)''': ''Function'': 3.0.1 Returns number of seconds between now and str. ''Examples:''
<syntaxhighlight lang="lua">domoticz.utils.stringToSeconds('09:00') -- number of seconds between now and 09:00 hr.
domoticz.utils.stringToSeconds('08:53:30 on fri') -- number of seconds between now and Friday at 08:53:30
domoticz.utils.stringToSeconds('08:53:30 on sat, sun') -- number of seconds between now and Saturday or Sunday at 08:53:30 ;whatever comes first</syntaxhighlight></li>
<li>'''toBase64(string)''': ''Function'': ) Encode a string to base64</li>
<li>'''toCelsius(f, relative)''': ''Function''. Converts temperature from Fahrenheit to Celsius along the temperature scale or when relative == true it uses the fact that 1F = 0.56C. So <code>toCelsius(5, true)</code> returns 5F*(1/1.8) = 2.78C.</li>
<li>'''toJSON(luaTable)''': ''Function''. Converts a Lua table to a json string.</li>
<li>'''toXML(luaTable, [header])''': ''Function''. Converts a Lua table to a xml string.</li>
<li>'''urlDecode(s)''': ''Function''. Simple deCoder to convert a string with escaped chars (%20, %3A and the likes) to human readable format.</li>
<li>'''urlEncode(s, [strSub])''': ''Function''. Simple url encoder for string so you can use them in <code>openURL()</code>. <code>strSub</code> is optional and defaults to + but you can also pass %20 if you like/need.</li>
<li>'''variableExists(parm)''': ''Function'': returns name when entered with a valid variable 3.0.12 or variableID and return ID when entered with valid variableName or false when not a variable, variableID or variableName of an existing variable</li>
<li>'''leadingZeros(number, length)''': ''Function'': Precede number with given zeros to given length.</li>
<li>'''variables(idx/name)''': ''Function''. A function returning a variable by it’s name or idx. See [Variable object API] (#Variable_object_API_.28user_variables.29) for the attributes. To iterate over all variables do: <code>domoticz.variables().forEach(..)</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. '''Note that you cannot do <code>for i, j in pairs(domoticz.variables()) do .. end</code>'''.</li></ul></li></ul>


=== Looping through the collections: iterators ===

The domoticz object has these collections (tables): devices, scenes, groups, variables, changedDevices and changedVariables. You cannot use the <code>pairs()</code> or <code>ipairs()</code> functions. Therefore dzVents has four iterator methods:

# '''find(function)''': Returns the item in the collection for which <code>function</code> returns true. When no item is found <code>find</code> returns nil.
# '''forEach(function)''': Executes function once per array element. The function receives the item in the collection (device or variable). If the function returns ''false'', the loop is aborted.
# '''filter(function / table)''': returns items in the collection for which the function returns true. You can also provide a table with names and/or ids.
# '''reduce(function, initial)''': Loop over all items in the collection and do some calculation with it. You call it with the function and the initial value. Each iteration the function is called with the accumulator and the item in the collection. The function does something with the accumulator and returns a new value for it.


==== Examples: ====

find():

<syntaxhighlight lang="lua"> local myDevice = domoticz.devices().find(function(device)
return device.name == 'myDevice'
end)
domoticz.log('Id: ' .. myDevice.id)</syntaxhighlight>
forEach():

<syntaxhighlight lang="lua"> domoticz.devices().forEach(function(device)
if (device.batteryLevel < 20) then
-- do something
end
end)</syntaxhighlight>
filter():

<syntaxhighlight lang="lua"> local deadDevices = domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end)
deadDevices.forEach(function(zombie)
-- do something
end)</syntaxhighlight>
or

<syntaxhighlight lang="lua"> local livingLights = {
'window',
'couch',
33, -- kitchen light id
}
local lights = domoticz.devices().filter(livingLights)
lights.forEach(function(light)
-- do something
light.switchOn()
end)</syntaxhighlight>
Of course you can chain:

<syntaxhighlight lang="lua"> domoticz.devices().filter(function(device)
return (device.lastUpdate.minutesAgo > 60)
end).forEach(function(zombie)
-- do something with the zombie
end)</syntaxhighlight>
Using a reducer to count all devices that are switched on:

<syntaxhighlight lang="lua"> local count = domoticz.devices().reduce(function(acc, device)
if (device.state == 'On') then
acc = acc + 1 -- increase the accumulator
end
return acc -- always return the accumulator
end, 0) -- 0 is the initial value for the accumulator</syntaxhighlight>

=== Constants ===

The domoticz object has these constants available for use in your code e.g. <code>domoticz.LOG_INFO</code>.

'''IMPORTANT: you have to prefix these constants with the name of your domoticz object. Example: <code>domoticz.ALERTLEVEL_RED</code>''':

* '''ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_ORANGE, ALERTLEVEL_RED, ALERTLEVEL_YELLOW''': for updating text sensors.
* '''BASETYPE_CUSTOM_EVENT 3.0.0,BASETYPE_DEVICE, BASETYPE_SCENE, BASETYPE_GROUP, BASETYPE_HARDWARE''' 3.0.7, '''BASETYPE_VARIABLE, BASETYPE_SECURITY, BASETYPE_TIMER, BASETYPE_HTTP_RESPONSE, BASETYPE_SYSTEM'''3.0.0: indicators for the various object types that are passed as the second parameter to the execute function. E.g. you can check if an object is a device object: <code>Lua if (item.baseType == domoticz.BASETYPE_DEVICE) then ... end</code>
* '''BARO_CLOUDY, BARO_CLOUDY_RAIN, BARO_STABLE, BARO_SUNNY, BARO_THUNDERSTORM, BARO_NOINFO, BARO_UNSTABLE, BARO_COMPUTE''' : for updating barometric values.
* '''EVENT_TYPE_DEVICE, EVENT_TYPE_VARIABLE, EVENT_TYPE_CUSTOM''', 3.0.0 '''EVENT_TYPE_SECURITY, EVENT_TYPE_HTTPRESPONSE, EVENT_TYPE_SYSTEM,''' 3.0.0 '''EVENT_TYPE_TIMER''': triggerInfo types passed to the execute function in your scripts.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_TEMPORARY_OVERRIDE, EVOHOME_MODE_PERMANENT_OVERRIDE, EVOHOME_MODE_FOLLOW_SCHEDULE''': mode for EvoHome system.
* '''EVOHOME_MODE_AUTO, EVOHOME_MODE_AUTOWITHRESET, EVOHOME_MODE_AUTOWITHECO, EVOHOME_MODE_AWAY, EVOHOME_MODE_DAYOFF, EVOHOME_MODE_CUSTOM, EVOHOME_MODE_HEATINGOFF''' : mode for EvoHome controller
* '''HUM_COMFORTABLE, HUM_DRY, HUM_NORMAL, HUM_WET, HUM_COMPUTE''' 3.0.15: constant for humidity status.
* '''INTEGER, FLOAT, STRING, DATE, TIME''': variable types.
* \**LOG_INFO, LOG_STATUS, LOG_ERROR, LOG_DEBUG, LOG_FORCE: for logging messages. LOG_FORCE will always be displayed.
* '''NSS_CLICKATELL''' 3.1.3, '''NSS_FIREBASE, NSS_FIREBASE_CLOUD_MESSAGING, NSS_GOOGLE_DEVICES,''' 3.0.10 Only with installed casting plugin, '''NSS_HTTP, NSS_KODI, NSS_LOGITECH_MEDIASERVER, NSS_NMA,NSS_PROWL, NSS_PUSHALOT, NSS_PUSHBULLET, NSS_PUSHOVER, NSS_PUSHSAFER, NSS_TELEGRAM, NSS_GOOGLE_CLOUD_MESSAGING''' deprecated by Google and replaced by firebase: for notification subsystem
* '''PRIORITY_LOW, PRIORITY_MODERATE, PRIORITY_NORMAL, PRIORITY_HIGH, PRIORITY_EMERGENCY''': for notification priority.
* '''SECURITY_ARMEDAWAY, SECURITY_ARMEDHOME, SECURITY_DISARMED''': for security state.
* '''STATE_IDLE, STATE_COOLING, STATE_HEATING''': for thermostat operating state.
* '''SOUND_ALIEN , SOUND_BIKE, SOUND_BUGLE, SOUND_CASH_REGISTER, SOUND_CLASSICAL, SOUND_CLIMB , SOUND_COSMIC, SOUND_DEFAULT, SOUND_ECHO, SOUND_FALLING, SOUND_GAMELAN, SOUND_INCOMING, SOUND_INTERMISSION, SOUND_MAGIC, SOUND_MECHANICAL, SOUND_NONE, SOUND_PERSISTENT, SOUND_PIANOBAR , SOUND_SIREN, SOUND_SPACEALARM, SOUND_TUGBOAT, SOUND_UPDOWN''': for notification sounds.


== Custom event API ==

If you have a dzVents script that is triggered by a customEvent in Domoticz then the second parameter passed to the execute function will be a ''notification'' object. The object.type = customEvent (isCustomEvent: true) and object.data contains the passed data to this script. object.trigger is the name of the customEvent that triggered the script.


== Device object API ==

If you have a dzVents script that is triggered by switching a device in Domoticz then the second parameter passed to the execute function will be a ''device'' object. Also, each device in Domoticz can be found in the <code>domoticz.devices()</code> collection (see above). The device object has a set of fixed attributes like ''name'' and ''idx''. Many devices, however, have different attributes and methods depending on their (hardware)type, subtype and other device specific identifiers. It is possible that you will get an error if you call a method on a device that doesn’t support it, so please check the device properties for your specific hardware to see which are supported (can also be done in your script code!).

dzVents recognizes most of the different device types in Domoticz and creates the proper attributes and methods. It is possible that your device type has attributes that are not recognized; if that’s the case, please create a ticket in the Domoticz [https://github.com/domoticz/domoticz/issues issue tracker on GitHub], and an adapter for that device will be added.

If for some reason you miss a specific attribute or data for a device, then likely the <code>rawData</code> attribute will have that information.


== Device attributes and methods for all devices ==

<ul>
<li>'''active''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Same as bState.</li>
<li>'''baseType''' ''String''. ‘camera’, ‘device’, ‘group’, ‘scene’, ‘hardware’, ‘uservariable’ or ‘security’</li>
<li>'''batteryLevel''': ''Number'' If applicable for that device then it will be from 0-100.</li>
<li>'''bState''': ''Boolean''. Is true for some common states like ‘On’ or ‘Open’ or ‘Motion’. Better to use active.</li>
<li>'''changed''': ''Boolean''. True if the device was updated. '''Note''': This does not necessarily means the device state or value changed.</li>
<li>'''customImage''': ''Number''. When customImage is used for the device-icon this will be the icon-number. It will be 0 if the icon was not changed.</li>
<li>'''description''': ''String''. Description of the device.</li>
<li>'''deviceId''': ''String''. Another identifier of devices in Domoticz. dzVents uses the id(x) attribute. See device list in Domoticz’ settings table.</li>
<li>'''deviceSubType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''deviceType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''dump()''': ''Function''. Dump all attributes except functions and complete time overview to the Domoticz log. This ignores the log level setting. Use fullDump to include everything.</li>
<li>'''dumpSelection([{‘attributes’} ‘functions’ ‘tables’])''': ''Function''. 3.0.5 Dump attributes, function-names or table-names to the Domoticz log. This ignores the log level setting.</li>
<li>'''fullDump()''' ''Function''. 3.1.16 Dump all attributes including functions and the complete time overview to the Domoticz log. This ignores the log level setting. Most of the time dump() shows everything what is needed to debug.</li>
<li>'''hardwareName''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareId''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareType''': ''String''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''hardwareTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''icon''': ''String''. Name of the icon in Domoticz GUI.</li>
<li>'''id''': ''Number''. Index of the device. You can find the index in the device list (idx column) in Domoticz settings. It’s not truly an index but is unique enough for dzVents to be treated as an id.</li>
<li>'''idx''': ''Number''. Same as id: index of the device</li>
<li>'''inActive''': ''Boolean''. 3.1.0 true if active is false and vice versa. If active is nil inActive is also nil</li>
<li>'''lastUpdate''': ''[[#Time_object|Time Object]]'': Time when the device was updated. **Note: The lastUpdate for devices that triggered the script at hand is in fact the previousUpdate time. The real lastUpdate time for these “script triggering” devices is the current time.</li>
<li>'''name''': ''String''. Name of the device.</li>
<li>'''nValue''': ''Number''. Numerical representation of the state.</li>
<li>'''protected''': ''Boolean''. True when device / scene / group is protected. False otherwise.</li>
<li>'''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]</li>
<li>'''protectionOn()''': ''Function''. switch protection to on. Supports some [command options] !! **Note: domoticz protects against GUI and API access only. switchOn / switchOff type Blockly / Lua / dzVents commands are not influenced (because they are executed as admin user)</li>
<li>'''rawData''': ''Table'': All values are ''String'' types and hold the raw data received from Domoticz.</li>
<li>'''rename(newName)''': ''Function''. Change current devicename to new devicename Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setDescription(description)''': ''Function''. Generic method to update the description for all devices, groups and scenes. E.g.: device.setDescription(device.description .. ‘/nChanged by’.. item.trigger .. ‘at’ .. domoticz.time.raw). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setIcon(iconNumber)''': ''Function''. method to update the icon for devices. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''setState(newState)''': ''Function''. Generic update method for switch-like devices. E.g.: device.setState(‘On’). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''resumeTimerPlan()''': ''Function''. Finds the most recent timer that should have fired today (before now) for this device, scene, or group and executes it immediately. Useful for restoring the correct state after a Domoticz restart or power cut. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. ```lua – Replay last timer for a device domoticz.devices(‘My Light’).resumeTimerPlan()
– Replay last timer for a scene domoticz.scenes(‘Evening Scene’).resumeTimerPlan()
– Replay last timer for a group domoticz.groups(‘All Lights’).resumeTimerPlan() ```</li>
<li>'''setValues(nValue,[ sValue1, sValue2, …])''': ''Function''. Generic alternative method to update device nValue, sValues. Uses domoticz JSON API to force subsequent pushes like influxdb and MQTT. nValue required but when set to nil it defaults to current nValue. sValue parms are optional and can be many. 3.0.8 If one of sValue parms is ‘parsetrigger’, subsequent eventscripts will be triggered.</li>
<li>'''state''': ''String''. For switches, holds the state like ‘On’ or ‘Off’. For dimmers that are on, it is also ‘On’ but there is a level attribute holding the dimming level. '''For selector switches''' (Dummy switch) the state holds the ''name'' of the currently selected level. The corresponding numeric level of this state can be found in the '''rawData''' attribute: <code>device.rawData[1]</code>.</li>
<li>'''signalLevel''': ''Number'' If applicable for that device then it will be from 0-12</li>
<li>'''switchType''': ''String''. See Domoticz devices table in Domoticz GUI(Switches tab). E.g. ‘On/Off’, ‘Door Contact’, ‘Motion Sensor’ or ‘Blinds’</li>
<li>'''sValue''': ''String''. Returns the sValue (string Value) of a device.</li>
<li>'''switchTypeValue''': ''Number''. See Domoticz devices table in Domoticz GUI.</li>
<li>'''timedOut''': ''Boolean''. Is true when the device couldn’t be reached.</li>
<li>'''unit''': ''Number''. Device unit. See device list in Domoticz’ settings for the unit.</li>
<li>'''update(< params >)''': ''Function''. Generic update method. Accepts any number of parameters that will be sent back to Domoticz. There is no need to pass the device.id here. It will be passed for you. Example to update a temperature: <code>device.update(0,12)</code>. This will eventually result in a commandArray entry <code>['UpdateDevice']='<idx>|0|12'</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li>
<li>'''updateQuiet(nValue, sValue)''': ''Function''. 3.0.18 Uses the JSON/API to send nValue and/or sValue to domoticz (at least one should be supplied). Will update the device status in the GUI and trigger events but will not execute the action on the device. Only useful when the status in the GUI is not in line with the actual status. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].</li></ul>


=== Device attributes and methods for specific devices ===

Note that if you do not find your specific device type here you can always inspect what is in the <code>rawData</code> attribute. Please let us know that it is missing so we can write an adapter for it (or you can write your own and submit it). Calling <code>myDevice.dump()</code> will dump all attributes and values for myDevice to the Domoticz log.


==== Air quality ====

* '''co2''': ''Number''. PPM
* '''quality''': ''String''. Air quality string.
* '''updateAirQuality(ppm)''': Pass the CO2 concentration. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Alert sensor ====

* '''color''': ''Number''. Color of the alert. See domoticz color constants for possible values.
* '''text''': ''String''
* '''updateAlertSensor(level, text)''': ''Function''. Level can be domoticz.ALERTLEVEL_GREY, ALERTLEVEL_GREEN, ALERTLEVEL_YELLOW, ALERTLEVEL_ORANGE, ALERTLEVEL_RED. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 1-phase ====

* '''current''': ''Number''. Ampère.
* '''updateCurrent(current)''': ''Function''. Current in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Ampère, 3-phase ====

* '''current1''', '''current2''', '''current3''' : ''Number''. Ampère.
* '''updateCurrent(current1, current2, current3)''': ''Function''. Currents in Ampère. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Barometer sensor ====

* '''barometer'''. ''Number''. Barometric pressure.
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''updateBarometer(pressure, forecast)''': ''Function''. Update barometric pressure. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Counter, managed Counter, counter incremental ====

* '''counter''': ''Number''
* '''counterToday''': ''Number''. Today’s counter value.
* '''updateCounter(value)''': ''Function''. '''Overwrite current value for managed and standard counters; increment for incremental counters !!'''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''updateHistory( date, sValues )''': ''Strings'' 3.1.3 ''function'' Managed counter only! Used to write values to short or long term storage.

<syntaxhighlight lang="lua"> local mCounter = domoticz.devices('device name')
mCounter.updateHistory('2021-01-22', '10;1777193') -- Write to long term storage (meter_calendar table)
mCounter.updateHistory('2021-01-22 10:05:02', '10;1777193') -- Write to short term storage (meter table)</syntaxhighlight>
* '''incrementCounter(value)''': ''Function''. (counter incremental) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. To update with a complete new value you will have to do some calculation and take the counter divider into account.

<syntaxhighlight lang="lua"> local newValue = value
local iCounter = domoticz.devices('device name')
local counterDivider = x -- x is depending on the counter divider set for the device
iCounter.incrementCounter( ( -1 * iCounter.counter * counterDivider ) + newValue )</syntaxhighlight>
* '''valueQuantity''': ''String''. For counters.
* '''valueUnits''': ''String''.


==== Custom sensor ====

* '''sensorType''': ''Number''.
* '''sensorUnit''': ''String'':
* '''sensorValue''': 3.0.11 ''Number'' where applicable; else ''String'':
* '''updateCustomSensor(value)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Distance sensor ====

* '''distance''': ''Number''.
* '''updateDistance(distance)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Electric usage ====

* '''actualWatt''': ''Number''. Current Watt usage.
* '''WhActual''': ''Number''. Current Watt usage. (please use actualWatt)
* '''updateEnergy(energy)''': ''Function''. In Watt. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Evohome (controller) ====

* '''mode''': ''string'' 3.0.0.
* '''setMode(mode, dparm, action, ooc )''': ''Function''. set mode for controller. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_AUTOWITHRESET, domoticz.EVOHOME_MODE_AUTOWITHECO, domoticz.EVOHOME_MODE_AWAY, domoticz.EVOHOME_MODE_DAYOFF, domoticz.EVOHOME_MODE_CUSTOM or domoticz.EVOHOME_MODE_HEATINGOFF. dParm <optional> can be a future time string (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>), a future time object, a future time as number of seconds since epoch or a number representing a positive offset in minutes (max 1 year). action <optional> (1 = run on action script, 0 = disable), ooc <optional> (1 = only trigger the event & log on change, 0 = always trigger & log)


==== Evohome (hotWater) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''mode''': ''string''
* '''untilDate''': ''string in ISO 8601 format'' or n/a.
* '''setHotWater(state, mode, until)''': ''Function''. set HotWater Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE You can provide an until date (in ISO 8601 format for domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>).


==== Evohome (relay) ====

* '''state''': ''string'' (‘On’ or ‘Off’)
* '''level''': ''number'' (level percentage)
* '''active''': ''boolean'' (true when state is not equal to ‘Off’, false otherwise)


==== Evohome (zones) ====

* '''setPoint''': ''Number''.
* '''mode''': ''string'' .
* '''untilDate''': ''string in ISO 8601 format'' or n/a .
* '''updateSetPoint(setPoint, mode, until)''': ''Function''. Update set point. Mode can be domoticz.EVOHOME_MODE_AUTO, domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE, domoticz.EVOHOME_MODE_FOLLOW_SCHEDULE or domoticz.EVOHOME_MODE_PERMANENT_OVERRIDE. You can provide an until date (in ISO 8601 format e.g.: <code>os.date("!%Y-%m-%dT%TZ")</code>). When leaving out untilDate for mode domoticz.EVOHOME_MODE_TEMPORARY_OVERRIDE the untilDate will be the next scheduled zone-update time/date. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Gas ====

* '''counter''': ''Number''. Value in m3
* '''counterToday''': ''Number''. Value in m3
* '''updateGas(usage)''': ''Function''. Usage in '''dm3''' (liters). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Group ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current group-name to new group-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleGroup()''': Toggles the state of a group. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Hardware 3.0.7 ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''isHardware''': ''Boolean''
* '''isPythonPlugin''': ''Boolean''
* '''type''': : ''String''
* '''typeValue''': : ''Number''


==== Humidity sensor ====

* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''updateHumidity(humidity, status)''': Update humidity. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Kodi ====

* '''kodiExecuteAddOn(addonId)''': ''Function''. Will send an Execute Addon command sending no parameters. Addon IDs are embedded in the addon configuration and are not to be confused with the Addon Name. For example: http://forums.homeseer.com/showthread.php?p=1213403.
* '''kodiPause()''': ''Function''. Will send a Pause command, only effective if the device is streaming.
* '''kodiPlay()''': ''Function''. Will send a Play command, only effective if the device was streaming and has been paused.
* '''kodiPlayFavorites([position])''': ''Function''. Will play an item from the Kodi’s Favorites list optionally starting at ''position''. Favorite positions start from 0 which is the default.
* '''kodiPlayPlaylist(name, [position])''': ''Function''. Will play a music or video Smart Playlist with ''name'' optionally starting at ''position''. Playlist positions start from 0 which is the default.
* '''kodiSetVolume(level)''': ''Function''. Set the volume for a Kodi device, 0 <= level <= 100.
* '''kodiStop()''': ''Function''. Will send a Stop command, only effective if the device is streaming.
* '''kodiSwitchOff()''': ''Function''. Will turn the device off if this is supported in settings on the device.


==== kWh, Electricity (instant and counter) ====

* '''actualWatt''': ''Number''. Actual usage in Watt.
* '''counterToday''': ''Number''.
* '''updateElectricity(power, energy)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''WhToday''': ''Number''. Total Wh usage of the day. Note the unit is Wh and not kWh!
* '''WhTotal''': ''Number''. Total Wh usage.
* '''WhActual''': ''Number''. Actual reading in Watt. Please use actualWatt


==== Leaf wetness ====

* '''wetness''': ''Number''. Wetness value
* '''updateWetness(wetness)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Logitech Media Server ====

* '''pause()''': ''Function''. Will pause the device if it was streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''play()''': ''Function''. If the device was off, it will turn on and start streaming. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playFavorites([position])''': ''Function''. Will start the favorites playlist. <code>position</code> is optional (0 = default). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''playlistID''': ''Nubmer''.
* '''setVolume(level)''': ''Function''. Sets the volume (0 <= level <= 100). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''startPlaylist(name)''': ''Function''. Will start the playlist by its <code>name</code>. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Will stop the device (only effective if the device is streaming). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeUp()''': ''Function''. Will turn the device volume up with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''volumeDown()''': ''Function''. Will turn the device volume down with 2 points. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Lux sensor ====

* '''lux''': ''Number''. Lux level for light sensors.
* '''updateLux(lux)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Onkyo receiver ====

* '''onkyoEISCPCommand(command)'''. ''Function''. Sends an EISP command to the Onkyo receiver.


==== OpenTherm gateway ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== P1 Smart meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterToday''': ''Number''.
* '''usage1''', '''usage2''': ''Number''.
* '''return1''', '''return2''': ''Number''.
* '''updateP1(usage1, usage2, return1, return2, cons, prod)''': ''Function''. Updates the device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''usage''': ''Number''.
* '''usageDelivered''': ''Number''.


==== Percentage ====

* '''percentage''': ''Number''.
* '''updatePercentage(percentage)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Philips Hue Light ====

See switch below.


==== Pressure ====

* '''pressure''': ''Number''.
* '''updatePressure(pressure)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Rain meter ====

* '''rain''': ''Number'' (please note that this does return the rain total for today)
* '''rainRate''': ''Number''
* '''updateRain(rate, counter)''': ''Function''. (rate in mm * 100 per hour, counter is total in mm) Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== RGBW(W) / Lighting Limitless/Applamp ====

* '''decreaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''getColor()'''; ''Function''. Returns table with color attributes or nil when color field of device is not set.
* '''increaseBrightness()''': deprecated because only very limited supported and will be removed from API
* '''setColor(r, g, b, br, cw, ww, m, t)''': ''Function''. Sets the light to requested color. r, g, b required, others optional. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. Meaning and limits of parms can be found [https://wiki.domoticz.com/Domoticz_API/JSON_URL's#Set_a_light_to_a_certain_color_or_color_temperature here].
* '''setColorBrightness()''': same as setColor
* '''setDiscoMode(modeNum)''': deprecated because only very limited supported and will be removed from API
* '''setHex(r, g, b)''': ''Function''. Sets the light to requested color. r, g, b required (decimal Values 0-255). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setHue(hue, brightness, isWhite)''': ''Function''. Sets the light to requested Hue. Hue and brightness required. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setKelvin(Kelvin)''': ''Function''. Sets Kelvin level of the light (For RGBWW devices only). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setNightMode()''': ''Function''. Sets the lamp to night mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setRGB(red, green, blue)''': ''Function''. Set the lamps RGB color. Values are from 0-255. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setWhiteMode()''': ''Function''. Sets the lamp to white mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scale weight ====

* '''weight''': ''Number''
* '''udateWeight()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Scene ====

* '''devices()''': ''Function''. Returns the collection of associated devices. Supports the same iterators as for <code>domoticz.devices()</code>: <code>forEach()</code>, <code>filter()</code>, <code>find()</code>, <code>reduce()</code>. See [[#Looping_through_the_collections:_iterators|Looping through the collections: iterators]]. Note that the function doesn’t allow you to get a device by its name or id. Use <code>domoticz.devices()</code> for that.
* '''protectionOff()''': ''Function''. switch protection to off. Supports some [command options]
* '''protectionOn()''': ''Function''. switch protection to on. Supports some [command options]
* '''rename(newName)''': ''Function''. Change current scene-name to new scene-name Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Security Panel ====

Create a security device:

# Set a security panel password in Domoticz settings.
# Activate the security panel ('''Setup > More Options > Security Panel''' and set it to '''Disarm''' (using your password)).
# Go to the device list in ('''Setup > Devices''') where it should show the security panel device under ‘Not used’.
# Add the device and give it a name.

Methods/attributes:

* '''armAway()''': Sets a security device to Armed Away. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''armHome()''': Sets a security device to Armed Home. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''disarm()''': Disarms a security device. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''state''': ''String'': Same values as domoticz.security value.


==== Smoke detection ====

* '''activate()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''reset()''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Solar radiation ====

* '''radiation'''. ''Number''. In Watt/m2.
* '''updateRadiation(radiation)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Soil moisture ====

* '''moisture'''. ''Number''. In centibars (cB).
* '''updateSoilMoisture(moisture)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Sound level ====

* '''level'''. ''Number''. In dB.
* '''updateSoundLevel(level)''': ''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Switch (dimmer, selector etc.) ====

There are many switch-like devices. Not all methods are applicable for all switch-like devices. You can always use the generic <code>setState(newState)</code> method.

* '''close()''': ''Function''. Set device to Close if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''dimTo(percentage)''': ''Function''. Switch a dimming device on and/or dim to the specified level. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''lastLevel''': Number. The level of a dimmer just before it was switched off. '''Note: lastLevel only shows you the previous level if you have a trigger for the device itself. So for instance you have a on-trigger for ‘myDimmer’ and the dimmer is set from 20% to 30%, in your script <code>myDimmer.level == 30</code> and <code>myDimmer.lastLevel == 20</code>. '''
* '''level''': ''Number''. For dimmers and other ‘Set Level..%’ devices this holds the level like selector switches.
* '''levelActions''': ''String''. |-separated list of url actions for selector switches.
* '''levelName''': ''String''. Current level name for selector switches.
* '''levelNames''': ''Table''. Table holding the level names for selector switch devices.
* '''levelVal''': ''Number''. Specific for selector switches.
* '''maxDimLevel''': ''Number''.
* '''open()''': ''Function''. Set device to Open if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOn()''': ''Function''. Set deviceStatus to on without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''quietOff()''': ''Function''. set deviceStatus to off without physically switching it. Subsequent Events are triggered. Supports some [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''setLevel(percentage)''': ''Function''. Set device to a given level if it supports it (e.g. blinds percentage). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''stop()''': ''Function''. Set device to Stop if it supports it (e.g. blinds). Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOff()''': ''Function''. Switch device off it is supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchOn()''': ''Function''. Switch device on if it supports it. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''switchSelector(<[level]|[levelname] >)''' : ''Function''. Switches a selector switch to a specific level ( levelname or level(numeric) required ) levelname must be exact, for level the closest fit will be picked. See the edit page in Domoticz for such a switch to get a list of the values). Levelname is only supported when level 0 (“Off”) is not removed Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].
* '''toggleSwitch()''': ''Function''. Toggles the state of the switch (if it is togglable) like On/Off, Open/Close etc.


==== Temperature sensor ====

* '''temperature''': ''Number''
* '''updateTemperature(temperature)''': ''Function''. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Barometer sensor ====

* '''barometer''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''temperature''': ''Number''
* '''updateTempBaro(temperature, pressure, forecast)''': ''Function''. Forecast can be domoticz.BARO_STABLE, BARO_SUNNY, BARO_CLOUDY, BARO_UNSTABLE, BARO_THUNDERSTORM. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity, Barometer sensor ====

* '''barometer''': ''Number''
* '''dewPoint''': ''Number''
* '''forecast''': ''Number''.
* '''forecastString''': ''String''.
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHumBaro(temperature, humidity, status, pressure, forecast)''': ''Function''. forecast can be domoticz.BARO_NOINFO, BARO_SUNNY, BARO_PARTLY_CLOUDY, BARO_CLOUDY, BARO_RAIN. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET, HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Temperature, Humidity ====

* '''dewPoint''': ''Number''
* '''humidity''': ''Number''
* '''humidityStatus''': ''String''
* '''humidityStatusValue''': ''Number''. Value matches with domoticz.HUM_NORMAL, -HUM_DRY, HUM_COMFORTABLE, -HUM_WET.
* '''temperature''': ''Number''
* '''updateTempHum(temperature, humidity [, status] )''': ''Function''. status can be domoticz.HUM_NORMAL, HUM_COMFORTABLE, HUM_DRY, HUM_WET or HUM_COMPUTE (let dzVents do the math)3.0.15. Note: temperature must be in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Text ====

* '''text''': ''String''
* '''updateText(text)''': Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat set point ====

* '''setPoint''': ''Number''.
* '''updateSetPoint(setPoint)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat Operating state 3.0.19 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat type 3 (Mertik) 3.0.15 ====

* '''mode''': ''Number''. Current mode
* '''modes''': ''String''. List of all modes
* '''modeString''': ''String''. Current mode
* '''updateMode(mode)''':''Function''. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Thermostat 6 3.1.11 ====

Thermostat 6 devices come in several subtypes: Temp/Setpoint, Temp/Hum/Setpoint, Temp/Baro/Setpoint and Temp/Hum/Baro/Setpoint. - '''setPoint''': ''Number''. The current set point. - '''humidityStatusValue''': ''Number''. Mapped humidity status value (only for subtypes with humidity). - '''updateSetPoint(setPoint)''': ''Function''. Update the set point. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]]. - '''updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)''': ''Function''. Update thermostat values. Parameters depend on the subtype: - ''Temp/Setpoint'': <code>updateThermostat(temperature, setPoint)</code> - ''Temp/Hum/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus)</code> - ''Temp/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, nil, nil, barometer, forecast)</code> - ''Temp/Hum/Baro/Setpoint'': <code>updateThermostat(temperature, setPoint, humidity, humidityStatus, barometer, forecast)</code> - <code>forecast</code> can be a string: <code>'noinfo'</code>, <code>'sunny'</code>, <code>'partlycloudy'</code>, <code>'cloudy'</code>, <code>'rain'</code> or a numeric value. - <code>humidityStatus</code> can be a string: <code>'dry'</code>, <code>'normal'</code>, <code>'comfortable'</code>, <code>'wet'</code> or a numeric value. If omitted with humidity provided, it is auto-calculated.


==== UV sensor ====

* '''uv''': ''Number''. UV index.
* '''updateUV(uv)''': ''Function''. UV index. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Visibility ====

* '''visibility''': ''Number''. In km.
* '''updateVisibility(distance)''':Function*. In km. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Voltage ====

* '''voltage''': ''Number''.
* '''updateVoltage(voltage)''':Function*. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Waterflow ====

* '''flow''': ''Number''. In L/m.
* '''updateWaterflow(flow)''':Function*. In L/m. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Wind ====

* '''chill''': ''Number''.
* '''direction''': ''Number''. Degrees.
* '''directionString''': ''String''. Formatted wind direction like N, SE.
* '''gust''': ''Number''. ( in meters / second, might change in future releases to Meters/Counters settings for Wind Meter )
* '''gustMs''': ''Number''. Gust ( in meters / second )
* '''temperature''': ''Number''
* '''speed''': ''Number''. Windspeed ( in the unit set in Meters/Counters settings for Wind Meter )
* '''speedMs''': ''Number''. Windspeed ( in meters / second )
* '''updateWind(bearing, direction, speed, gust, temperature, chill)''': ''Function''. Bearing in degrees, direction in N, S, NNW etc, speed in m/s, gust in m/s, temperature and chill in Celsius. Use <code>domoticz.toCelsius()</code> to convert a Fahrenheit temperature to Celsius. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Youless meter ====

* '''counterDeliveredToday''': ''Number''.
* '''counterDeliveredTotal''': ''Number''.
* '''powerYield''': ''String''.
* '''updateYouless(total, actual)''': ''Function''.


==== Zone heating ====

* '''setPoint''': ''Number''.
* '''heatingMode''': ''String''.


==== Z-Wave Fan mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


==== Z-Wave Thermostat mode ====

* '''mode''': ''Number''. Current mode number.
* '''modeString''': ''String''. Mode name.
* '''modes''': ''Table''. Lists all available modes.
* '''updateMode(modeString)''': ''Function''. Set new mode. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== Command options (delay, duration, event triggering) ===

Many dzVents device methods support extra options, like controlling a delay or a duration:

<syntaxhighlight lang="lua">
-- switch on for 2 minutes after 10 seconds
device.switchOn().afterSec(10).forMin(2)

-- switch on at a specic time / day
device.switchOn().at('09:00') -- earliest moment it will be 09:00 hr.
device.switchOn().at('08:53:30 on fri') -- earliest moment it will be Friday at 08:53:30
device.switchOn().at('08:53:30 on sat, sun') -- earliest moment it will be Saturday or Sunday at 08:53:30 (whatever comes first)

-- switch on for 2 minutes after a randomized delay of 1-10 minutes
device.switchOff().withinMin(10).forMin(2)
device.close().forMin(15)
device.open().afterSec(20)
device.open().afterMin(2)

-- switch on but do not trigger follow up events
device.switchOn().silent()

-- flash a light for 3 times
device.switchOn().forSec(2).repeatAfterSec(1, 3)

-- switch the device on but only if the current state isn't already on:
device.switchOn().checkFirst()
-- this is a short for:
if (device.state == 'Off') then
devices.switchOn()
end</syntaxhighlight>

==== Options ====

* '''at(hh:mm[:ss][ on [ ddd|dddd ] )''': ''Function''.3.0.1 Activates the command at a certain time [ on a certain day]
* '''afterHour(hours), afterMin(minutes), afterSec(seconds)''': ''Function''. Activates the command after a certain number of hours, minutes or seconds.
* '''cancelQueuedCommands()''': ''Function''. Cancels queued commands. E.g. you switch on a device after 10 minutes: <code>myDevice.switchOn().afterMin(10)</code>. Within those 10 minutes you can cancel that command by calling: <code>myDevice.cancelQueuedCommands()</code>.
* '''checkFirst()''': ''Function''. Checks if the '''current''' state of the device is different than the desired new state. If the target state is the same, no command is sent. If you do <code>mySwitch.switchOn().checkFirst()</code>, then no switch command is sent if the switch is already on. This command only works with switch-like devices. It is not available for toggle and dim commands, either.
* '''forHour(hours), forMin(minutes), forSec(seconds)''': ''Function''. Activates the command for the duration of hours, minutes or seconds. See table below for applicability and the warning on unexpected behavior of these functions.
* '''withinHour(hours), withinMin(minutes), withinSec(seconds)''': ''Function''. Activates the command within a certain period (specified in hours, minutes or seconds) ''randomly''. See table below for applicability.
* '''silent()''': ''Function''. No follow-up events will be triggered: <code>mySwitch.switchOff().silent()</code>.
* '''repeatAfterHour(hours, [number]), repeatAfterMin(minutes, [number]), repeatAfterSec(seconds, [number])''': ''Function''. Repeats the sequence ''number'' times after the specified duration (specified in hours, minutes, or seconds). If no ''number'' is provided, 1 is used. '''Note that <code>afterAAA()</code> and <code>withinAAA()</code> are only applied at the beginning of the sequence and not between the repeats!'''

Note that the actual switching or changing of the device is done by Domoticz and not by dzVents. dzVents only tells Domoticz what to do; if the options are not carried out as expected, this is likely a Domoticz or hardware issue.

'''Important note when using forAAA()''': Let’s say you have a light that is triggered by a motion detector. Currently the light is <code>Off</code> and you do this: <code>light.switchOn().forMin(5)</code>. What happens inside Domoticz is this: at t0 Domoticz issues the <code>switchOn()</code> command and schedules a command to restore the '''current''' state at t5 which is <code>Off</code>. So at t5 it will switch the light off.

If, however, ''before the scheduled <code>switchOff()</code> happens at t5'', new motion is detected and you send this command again at t2 then something unpredictable may seem to happen: ''the light is never turned off!'' This is what happens:

At t2 Domoticz receives the <code>switchOn().forMin(5)</code> command again. It sees a scheduled command at t5 and deletes that command (it is within the new interval). Then Domoticz performs the (unnecessary, it’s already on) <code>switchOn()</code> command. Then it checks the current state of the light which is <code>On</code>!! and schedules a command to return to that state at t2+5=t7. So, at t7 the light is switched on again. And there you have it: the light is not switched off and never will be because future commands will always be checked against the current on-state.

That’s just how it works and you will have to deal with it in your script. So, instead of simply re-issuing <code>switchOn().forMin(5)</code> you have to check the switch’s state first:

<syntaxhighlight lang="lua">if (light.active) then
light.switchOff().afterMin(5)
else
light.switchOn().forMin(5)
end</syntaxhighlight>
or issue these two commands ''both'' as they are mutually exclusive:

<syntaxhighlight lang="lua">light.switchOff().checkFirst().afterMin(5)
light.switchOn().checkFirst().forMin(5)</syntaxhighlight>

==== Availability ====

Some options are not available to all commands. All the options are available to device switch-like commands like <code>myDevice.switchOff()</code>, <code>myGroup.switchOn()</code> or <code>myBlinds.open()</code>. For updating (usually Dummy ) devices like a text device <code>myTextDevice.updateText('zork')</code> you can only use <code>silent()</code>. For thermostat setpoint devices and snapshot command silent() is not available. For commands for which dzVents must use openURL, only <code>at()</code> and <code>afterAAA()</code> methods are available. These commands are mainly the setAaaaa() commands for RGBW type devices.

See table below

{| class="wikitable"
!width="17%"| option
!align="center" width="10%"| state changes
!align="center" width="11%"| update commands
!align="center" width="12%"| user variables
!align="center" width="12%"| updateSetpoint
!align="center" width="8%"| snapshot
!align="center" width="10%"| triggerIFTTT
!align="center" width="12%"| execute ShellCommand
!align="center" width="12%"| emitEvent
|-
| <code>afterAAA()</code>1
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>at()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|-
| <code>forAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>withinAAA()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| •
|-
| <code>silent()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>repeatAfterAAA()</code>
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>checkFirst()</code>
|align="center"| • 2
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|-
| <code>cancelQueuedCommands()</code>
|align="center"| •
|align="center"| •
|align="center"| •
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a
|align="center"| n/a

|}

==== Notes on table ====

* '''Note 1''': AAA is a placeholder for <code>Min/Sec/Hour</code> affix e.g. <code>afterMin()</code>.
* '''Note 2''': for <code>domoticz.openURL()</code> only <code>at()</code>, <code>afterAAA()</code> and <code>withinAAA()</code> is available.
* '''Note 3''': Note 2 also applies for all commands depending on openURL (like rgbwwDevice.setAaa() commands).
* '''Note 4''': Including dimTo, switchSelector, setLevel and similar methods.


==== Follow-up event triggers ====

Normally if you issue a command, Domoticz will immediately trigger follow-up events, and dzVents will automatically trigger defined event scripts. If you trigger a scene, all devices in that scene will issue a change event. If you have event triggers for these devices, they will be executed by dzVents. If you don’t want this to happen, add <code>.silent()</code> to your commands (exception is updateSetPoint).


=== Create your own device adapter ===

If your device is not recognized by dzVents, you can still operate it using the generic device attributes and methods. It is much nicer, however, to have device specific attributes and methods. Existing recognized adapters are in <code>/path/to/domoticz/dzVents/runtime/device-adapters</code>. Copy an existing adapter and adapt it to your needs. You can turn debug logging on and inspect the file <code>domoticzData.lua</code> in the dzVents folder. There you will find the unique signature for your device type. Usually it is a combination of deviceType and deviceSubType, but you can use any of the device attributes in the <code>matches</code> function. The matches function checks if the device type is suitable for your adapter and the <code>process</code> function actually creates your specific attributes and methods. Also, if you call <code>myDevice.dump()</code> you will see all attributes and methods and the attribute <code>_adapters</code> shows you a list of applied adapters for that device. Finally, register your adapter in <code>Adapters.lua</code>. Please share your adapter when it is ready and working.


== Variable object API (user variables) ==

User variables created in Domoticz have these attributes and methods:


=== Variable attributes and methods ===

* '''changed''': ''Boolean''. Was the variable updated. '''Note''': update does not necessarily means the variable value or type changed.
* '''date''': ''Date''. If type is domoticz.DATE. See lastUpdate for the sub-attributes.
* '''id''': ''Number''. Index of the variable.
* '''lastUpdate''': ''[[#Time_object|Time Object]]''
* '''name''': ''String''. Name of the variable
* '''rename(newName)''': ''Function''. Change current variable name to new variable name. (does not support timing options)
* '''set(value)''': Tells Domoticz to update the variable. Supports timing options. See [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|above]].
* '''time''': ''Date''. If type is domoticz.TIME. See lastUpdate for the sub-attributes.
* '''type''': ''String''. Can be domoticz.INTEGER, domoticz.FLOAT, domoticz.STRING, domoticz.DATE, domoticz.TIME.
* '''value''': ''String|Number|Date|Time''. Value of the variable.

<syntaxhighlight lang="lua">
return
{
on =
{
timer = {'Every 10 minutes on mon,tue,wed,thu,fri'}
},

execute = function(domoticz)
-- check time of the day
if (domoticz.time.isDayTime and domoticz.variables('myVar').value == 10) then
domoticz.variables('anotherVar').set(15)
end
end
}
</syntaxhighlight>

== Time object ==

Many attributes represent a moment in time, like <code>myDevice.lastUpdate</code> or <code>domoticz.time</code>. In dzVents, a time-like attribute is an object with properties and methods which make your life easier.

<syntaxhighlight lang="lua"> print(myDevice.lastUpdate.minutesAgo)
print(myDevice.lastUpdate.daysAgo)

-- compare two times
print(domoticz.time.compare(myDevice.lastUpdate).secs))</syntaxhighlight>
You can also create your own:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00') -- must be this format!!</syntaxhighlight>
If you don’t pass a time string:

<syntaxhighlight lang="lua"> local Time = require('Time')
local currentTime = Time()</syntaxhighlight>
Use this in combination with the various dzVents time attributes:

<syntaxhighlight lang="lua"> local Time = require('Time')
local t = Time('2016-12-12 07:35:00')

local tonight = Time(domoticz.time.rawDate .. ' 20:00:00')
print (tonight.getISO())
-- will print something like: 2016-12-12T20:00:00Z
print(t.minutesAgo) -- difference from 'now' in minutes

-- and you can feed it with all same rules as you use
-- for the timer = { .. } section:
if (t.matchesRule('at 16:00-21:00')) then
-- t is in between 16:00 and 21:00
end

-- very powerful if you want to compare two time instances:
local anotherTime = Time('...') -- fill-in some time here
print(t.compare(anotherTime).secs) -- diff in seconds between t and anotherTime.</syntaxhighlight>

=== System event API ===

If you have a dzVents script that is triggered by a system-event in Domoticz then the second parameter passed to the execute function will be a ''system'' object. The object.type = system-event that triggered the script. ( object.isSystemEvent: true) For backups the object also contains location and durationin seconds.


=== Time properties and methods ===

Creation:

<syntaxhighlight lang="lua">local Time = require('Time')
local now = Time() -- current time
local someTime = Time('2017-12-31 22:19:15')
local utcTime = Time('2017-12-31 22:19:15', true)</syntaxhighlight>
Creation:

<syntaxhighlight lang="lua">local someTime = domoticz.time.addMinutes(30) -- someTime = domoticz time object for now + 30 minutes
local someTime = domoticz.time.makeTime() -- someTime = new domoticz time object.</syntaxhighlight>
* '''addAAA(offset)''': ''time object''. time object with given offset (positive or negative. AAA is a placeholder for <code>Seconds, Minutes, Hours or Days</code> affix e.g. `addHours(-2)
* '''civTwilightEndInMinutes''': ''Number''. Minutes from midnight until civTwilightEnd.
* '''civTwilightStartInMinutes''':''Number''. Minutes from midnight until civTwilightStart.
* '''compare(time)''': ''Function''. Compares the current time object with another time object. ''Make sure you pass a Time object!'' Returns a table (all values are ''positive'', use the compare property to see if ''time'' is in the past or future):
** '''milliseconds''': Total difference in milliseconds.
** '''seconds''': Total difference in whole seconds.
** '''minutes''': Total difference in whole minutes.
** '''hours''': Total difference in whole hours.
** '''days''': Total difference in whole days.
** '''compare''': 0 = both are equal, 1 = ''time'' is in the future, -1 = ''time'' is in the past.
* '''dateToDate( dateString, sourceFormat, targetFormat[ , offSet] )''':3.0.17 ''Function'': Returns a reformatted datestring. dateString is a formatted date and source- and targetFormat are representations of the dateString elements and their locations in the string (see examples in dateToTimestamp) . Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'dddd dd mmmm hh:MM:ss', 1 ) -- > 'Friday 31 December 23:31:06'
domoticz.time.dateToDate('31/12/2021 23:31:05','dd/mm/yyyy hh:MM:ss', 'ddd dd mmm hh:MM:ss', -3600 * 24 - 3 )) -- > 'Thu 30 Dec 23:31:02'</syntaxhighlight>
* '''dateToTimestamp([ dateString [,control] ] )''': ''Function'': Returns ''Number'' representing time since epoch in seconds. dateString is a formatted date and control is a representation of the dateString elements and their location in the string. Default control is ‘yyyy-mm-dd hh:MM’. recognized controls are either a Lua pattern string or a string containing following codes:

<syntaxhighlight lang="lua"> dddd -- full weekdayname(e.g. Wednesday) language depends on locale
ddd -- abbreviated weekdayname(e.g. Wed) language depends on locale
dd -- day of the month {[01-31]
mmmm -- full monthname(e.g September) language depends on locale
mmm -- abbreviated monthname(e.g. Sep) language depends on locale
mm -- month [01-12]
yyyy -- 4 digit year
yy -- 2 digit year
hh -- hour 24-hour clock
ii -- hour 12-hour clock
MM -- minute
ss -- second
W -- weeknumber [01-53]
w -- weekday{[0-6] Sunday-Saturday
datm -- date and time (e.g. 09/16/98 23:48:10) format depends on locale
mer -- either "AM" or "PM" locale
date -- date(e.g. 09/16/98) format depends on locale
time -- time (e.g. 23:48:10)

-- examples:
domoticz.time.dateToTimestamp('2020-12-31 23:59')) -- > 1609455540
domoticz.time.dateToTimestamp('2020-12-31 23:59:01','yyyy-mm-dd hh:MM:ss')) -- > 1609455541
domoticz.time.dateToTimestamp('December 31, 23:59:02','mmmm dd, hh:MM:ss')) -- > 1609455542
domoticz.time.dateToTimestamp('2020-12-31 23:59:03','(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)%D+(%d+)' )) -- > 1609455543
domoticz.time.dateToTimestamp('20201231235904','(%d%d%d%d)(%d%d)(%d%d)(%d%d)(%d%d)(%d%d)')) -- > 1609455544</syntaxhighlight>
* '''day''': ''Number''
* '''dayAbbrOfWeek''': ''String''. sun,mon,tue,wed,thu,fri or sat
* '''daysAgo''': ''Number''
* '''dayName''': ''String''. complete name Sunday, Monday, etc
* '''dDate''': ''Number''. timestamp (seconds since 01/01/1970 00:00)
* '''getISO''': ''Function''. Returns the ISO 8601 formatted date.
* '''hour''': ''Number''
* '''hoursAgo''': ''Number''. Number of hours since the last update.
* '''isdst''': ''Boolean''. 3.0.18 Indicates if time is in the daylight saving period
* '''isToday''': ''Boolean''. Indicates if time is today
* '''isUTC''': ''Boolean''.
* '''makeTime(string | table,[isUTC])''': ''domoticz time object''. returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. isUTC defaults to false.
* '''matchesRule(rule) ''': ''Function''. Returns true if the rule matches with the time. See [[#timer_trigger_rules|time trigger rules]] for rule examples.
* '''millisecondsAgo''': ''Number''. Number of milliseconds since the last update.
* '''minutes''': ''Number''
* '''minutesAgo''': ''Number''. Number of minutes since the last update.
* '''minutesSinceMidnight''': ''Number''
* '''month''': ''Number''
* '''monthAbbrName''': String. jan, feb, mar, etc
* '''monthName''': ''String''. January, February, etc
* '''msAgo''': ''Number''. Number of milliseconds since the last update.
* '''raw''': ''String''. Generated by Domoticz
* '''rawDate''': ''String''. Returns the date part of the raw data.
* '''rawDateTime''': ''String''. Combined date / time formatted as domoticz does in API / JSON returns (rawDate .. ’ ’.. rawTime )
* '''rawTime''': ''String''. Returns the time part of the raw data as HH:MM:SS
* '''seconds''': ''Number''
* '''secondsSinceMidnight''': ''Number''
* '''secondsAgo''': ''Number''. Number of seconds since the last update.
* '''sunsetInMinutes''': ''Number''. Minutes from midnight until sunset.
* '''sunriseInMinutes''': ''Number''. Minutes from midnight until sunrise.
* '''solarnoonInMinutes''': ''Number''. 3.0.11 Minutes from midnight until solarnoon.
* '''time''': ''String''. Returns the time part of the raw data as HH:MM
* '''timestampToDate([ [ timestamp ] , [ pattern ] ,[ offSet ] )''': ''function''. Returns a datestring. timestamp is number of seconds since epoch (default = now) , pattern is a string as explained in this wiki at the description of the domoticz.time.dateToTimestamp function (default = ‘yyyy-mm-dd hh:MM:ss’). Offset is a number (default = 0 )

<syntaxhighlight lang="lua"> -- examples:
domoticz.time.timestampToDate(10,'date time') --> '01/01/70 01:00:10'
domoticz.time.timestampToDate(60,'ddd mm mmm yyyy ii:MM mer','date time') --> 'Thu 01 Jan 1970 01:01 AM''
domoticz.time.timestampToDate(1598077445,'dd/mm/yy ii:MM mer nZero') --> '22/08/20 8:24 AM'</syntaxhighlight>
* '''toUTC(string | table,[offset])''': ''domoticz time object''. 3.0.9 returns domoticz time object based on first parameter (time as table or string) string format must be ‘yyyy-mm-dd hh:mm:ss’. offset defaults to 0.
* '''utcSystemTime''': ''Table''. UTC system time (only when in UTC mode):
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''utcTime''': ''Table''. Time stamp in UTC time:
** '''day''': ''Number''
** '''hour''': ''Number''
** '''month''': ''Number''
** '''minutes''': ''Number''
** '''seconds''': ''Number''
** '''year''': ''Number''
* '''year''': ''Number''
* '''wday''': ''Number'' day of the week. Sunday = 1, Saturday = 7
* '''week''': ''Number'' week of the year

'''Note: it is currently not possible to change the domoticz.time object instance.''' ( but you can create a new one with- or without an offset)


== Shared helper functions ==

It is not unlikely that at some point you want to share Lua code among your scripts. Normally in Lua you would have to create a module and require that module in all you scripts. But dzVents makes that easier for you: Inside your scripts folder or in Domoticz’ GUI web editor, create a <code>global_data.lua</code> script (same as for global persistent data) and feed it with this code:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(param1, param2)
-- do your stuff
end,
MY_CONSTANT = 100 -- doesn't have to be a function
}
}</syntaxhighlight>
Save the file and then you can use myHandyFunction everywhere in your event scripts:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction('bla', 'boo')
print(domoticz.helpers.MY_CONSTANT)
end
}</syntaxhighlight>
No <code>require</code> or <code>dofile</code> is needed.

'''Important note: if you need to access the domoticz object in your helper function you have to pass it as a parameter:'''

Example:

<syntaxhighlight lang="lua">return {
helpers = {
myHandyFunction = function(domoticz, param1, param2)
-- do your stuff
domoticz.log('Hey')
end
}
}</syntaxhighlight>
And pass it along:

<syntaxhighlight lang="lua">return {
...
execute = function(domoticz, device)
local results = domoticz.helpers.myHandyFunction(domoticz, 'bla', 'boo')
end
}</syntaxhighlight>
'''Note''': there can be only '''one''' <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.


== Requiring your own modules ==

If you don’t want to use the helpers support, but you want to require your own modules, place them either in <code>/path/to/domoticz/scripts/dzVents/modules</code> or <code>/path/to/domoticz/scripts/dzVents/scripts/modules</code> as these folders are already added to the Lua package path. You can just require those modules: <code>local myModule = require('myModule')</code>


= Persistent data =

In many situations you need to store a device state or other information in your scripts for later use. Like knowing what the state was of a device the previous time the script was executed or what the temperature in a room was 10 minutes ago. Without dzVents, you had to resort to user variables. These are global variables that you create in the Domoticz GUI and that you can access in your scripts like: domoticz.variables(‘previousTemperature’).

Now, for some this is rather inconvenient and they want to control this state information in the event scripts themselves or want to use all of Lua’s variable types. dzVents has a solution for that: '''persistent script data'''. This can either be on the script level or on a global level.


== Script level persistent variables ==

The values in persistent script variables persist and can be retrieved in the next script run.

For example, send a notification if a switch has been activated 5 times:

<syntaxhighlight lang="lua"> return {
on = {
devices = { 'MySwitch' }
},
data = {
counter = { initial = 0 }
},
execute = function(domoticz, switch)
if (domoticz.data.counter == 5) then
domoticz.notify('The switch was pressed 5 times!')
domoticz.data.counter = 0 -- reset the counter
else
domoticz.data.counter = domoticz.data.counter + 1
end
end
}</syntaxhighlight>
The <code>data</code> section defines a persistent variable called <code>counter</code>. It also defines an initial value. From then on you can read and set the variable in your script.

You do not have to provide an initial value though. In that case the initial value is ''nil'':

<syntaxhighlight lang="lua"> return {
--
data = {
'x', 'y', 'z' -- note the quotes
},
execute = function(domoticz, item)
print(tostring(domoticz.data.x)) -- prints nil
end
}</syntaxhighlight>
You can define as many variables as you like and put whatever value in there that you like. It doesn’t have to be just a number. Just don’t put something in there with functions (well, they are filtered out actually).


=== Size matters and watch your speed!! ===

If you include tables (or arrays) in the persistent data, beware to not let them grow. It will definitely slow down script execution because dzVents has to serialize and deserialize the data. It is better to use the historical option as described below.


=== Re-initializing a variable ===

You can re-initialize a persistent variable and re-apply the initial value as defined in the data section:

<syntaxhighlight lang="lua">return {
on = { .. },
data = {
x = { initial = 'initial value' }
},
execute = function(domoticz, item)
if (domoticz.data.x ~= 'initial value') then
domoticz.data.initialize('x')
print(domoticz.data.x) -- will print 'initial value'
end
end
}</syntaxhighlight>
Note that <code>domoticz.data.initialize('<varname>')</code> is just a convenience method. You can of course create a local variable in your module holding the initial value and use it in your data section and your execute function.


== Global persistent variables ==

Script level variables are only available in the scripts that define them, but global variables can be accessed and changed in every script. To utilize global persistent variables, create a script file called <code>global_data.lua</code> in your scripts folder with this content (same file where you can also put your shared helper functions):

<syntaxhighlight lang="lua"> return {
helpers = {},
data = {
peopleAtHome = { initial = false },
heatingProgramActive = { initial = false }
}
}</syntaxhighlight>
Just define the variables that you need and access them in your scripts:

<syntaxhighlight lang="lua"> return {
on = {
devices = {'WindowSensor'}
},
execute = function(domoticz, windowSensor)
if (domoticz.globalData.heatingProgramActive
and windowSensor.state == 'Open') then
domoticz.notify("Hey don't open the window when the heating is on!")
end
end
}</syntaxhighlight>
'''Note''': there can be only one <code>global_data.lua</code> on your system. Either in <code>/path/to/domoticz/scripts/dzVents/script</code> or in Domoticz’ internal GUI web editor.

You can use <code>domoticz.globalData.initialize('<varname>')</code> just as like <code>domoticz.data.initialize('<varname>')</code>.


== A special kind of persistent variables: ''history = true'' (Historical variables API) ==

In some situations, storing a previous value for a sensor is not enough, and you would like to have more previous values. For example, you want to calculate an average over several readings. Of course you can define a persistent variable holding a table:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
previousData = { initial = {} }
},
execute = function(domoticz, sensor)
-- add new data
table.insert(domoticz.data.previousData, sensor.temperature)

-- calculate the average
local sum = 0, count = 0
for i, temp in pairs(domoticz.data.previousData) do
sum = sum + temp
count = count + 1
end
local average = sum / count
end
}</syntaxhighlight>
The problem with this is that you have to do a lot of bookkeeping to make sure that there isn’t too much data to store (see [[#How_does_the_storage_stuff_work.3F|below for how it works]]) . Fortunately, dzVents has done this for you:

<syntaxhighlight lang="lua"> return {
active = true,
on = {
devices = {'MyTempSensor'}
},
data = {
temperatures = { history = true, maxItems = 10 }
},
execute = function(domoticz, sensor)
-- add new data
domoticz.data.temperatures.add(sensor.temperature)

-- average
local average = domoticz.data.temperatures.avg()

-- maximum value in the past hour:
local max = domoticz.data.temperatures.maxSince('01:00:00')
end
}</syntaxhighlight>

=== Defining ===

Define a script variable or global variable in the data section and set <code>history = true</code>:

<syntaxhighlight lang="lua"> …
data = {
var1 = { history = true, maxItems = 10, maxHours = 1, maxMinutes = 5 }
}</syntaxhighlight>
* '''maxItems''': ''Number''. Controls how many items are stored in the variable. maxItems has precedence over maxHours and maxMinutes.
* '''maxHours''': ''Number''. Data older than <code>maxHours</code> from now will be discarded. E.g., if set to 2, then data older than 2 hours will be removed at the beginning of the script.
* '''maxMinutes''': ''Number''. Same as maxHours but, you guessed it: for minutes this time.. All these options can be combined. '''Reminder: don’t store too much data. Only put in what you really need!'''


=== Adding data ===

Add new values to a historical variable:

<pre>domoticz.data.myVar.add(value)</pre>
As soon as this new value is put on top of the list, the older values shift one place down the line. If <code>maxItems</code> is reached, then the oldest value will be discarded. ''All methods, like calculating averages or sums, will immediately use this new value!'' If you don’t want this to happen, set the new value at the end of your script or after you have done your analysis.

Any kind of data may be stored in the historical variable: numbers, strings, but also more complex data like tables. However, in order to use the [[#Statistical_functions|statistical methods]], numeric values are required.


=== Accessing values in historical variables ===

Values in a historical variable are indexed, where index 1 is the newest value, 2 is the second newest, and so on:

<pre>local item = domoticz.data.myVar.get(5)
print(item.data)</pre>
However, all data in the storage are time-stamped:

<pre>local item = domoticz.data.myVar.getLatest()
print(item.time.secondsAgo) -- access the time stamp
print(item.data) -- access the data</pre>
The time attribute by itself is a table with many properties that help you inspect the data points more easily. See [[#Time_object|Time Object]] for all attributes and methods.


==== Index ====

All data in the set can be addressed using an index. The item with index = 1 is the youngest, and the item with the highest index is the oldest. Beware, if you have called <code>add()</code> first, then the first item is that new value! You can always check the size of the set by inspecting <code>myVar.size</code>.


==== Time specification (''timeAgo'') ====

Every data point in the set has a timestamp and the set is ordered so that the youngest item is the first and the oldest item the last. Many functions require a moment in the past to be specified by passing a string in the format '''<code>hh:mm:ss</code>''', where ''hh'' is the number of hours ago, ''mm'' the number of minutes and ''ss'' the number of seconds. The times are added together, so you don’t have to consider 60 minute boundaries, etc. A time specification of <code>12:88:03</code> is valid, and points to the data point at or around <code>12*3600 + 88*60 + 3 = 48.483 seconds</code> in the past.

Example:

<pre>-- get average for the past 30 minutes:
local avg = myVar.avgSince('00:30:00')</pre>

==== Getting data points ====

* '''get(idx)''': Returns the idx-th item in the set. Same as <code>myVar.storage[idx]</code>.
* '''getAtTime([[#Time_specification_.28timeAgo.29|timeAgo]])''': Returns the data point ''closest'' to the moment as specified by <code>timeAgo</code> and the index in the set. So, <code>myVar.getAtTime('1:00:00')</code> returns the item that is closest to one hour old. It may be a bit younger or a bit older than 1 hour. The second return value is the index in the set: <code>local item, index = myVar.getAtTime('1:00:00')</code>
* '''getLatest( )''': Returns the youngest item in the set. Same as <code>print(myVar.get(1).data)</code>.
* '''getOldest( )''': Returns the oldest item in the set and the index. Same as <code>print(myVar.get(myVar.size).data)</code>. Note that the index is always the same as the total size. <code>local item, index = myVar.getOldest()</code>.
* '''size''': Return the number of data points in the set.
* '''subset( [fromIdx], [toIdx] )''': Returns a subset of the stored data. Default value, if omitted, of <code>fromIdx</code> is 1. Omitting <code>toIdx</code> takes all items until the end of the set (oldest). E.g., <code>myVar.subset()</code> returns all data. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''subsetSince( [[#Time_specification_.28timeAgo.29|timeAgo]] )''': Returns a subset of the stored data since the relative time specified by timeAgo. So calling <code>myVar.subsetSince('00:60:00')</code> returns all items that have been added to the list in the past 60 minutes. The result set supports [[#Looping_through_the_data:_iterators|iterators]] <code>forEach</code>, <code>filter</code>, <code>find</code> and <code>reduce</code>.
* '''reset( )''': Removes all the items from the set. It could be a good practice to do this often when you know you don’t need older data. For instance, when you turn on a heater and you just want to monitor rising temperatures starting from this moment when the heater is activated. If you don’t need data points from before, then you may call reset.


==== Looping through the data: iterators ====

Similar to the iterators as described [[#Looping_through_the_collections:_iterators|above]], there are convenience methods to make looping through the data set easier.

* '''forEach(function)''': Loop over all items in the set: E.g.: <code>myVar.forEach( function( item, index, collection) ... end )</code>
* '''filter(function)''': Create a filtered set of items. The function receives the item and returns true if the item is in the result set. E.g. get a set with item values larger than 20: <code>subset = myVar.filter( function (item) return (item.data > 20) end )</code>.
* '''find(function)''': Search for a specific item in the set: E.g. find the first item with a value higher than 20: <code>local item = myVar.find( function (item) return (item.data > 20) end )</code>.
* '''reduce(function, initial)''': Loop over all items in the set and do some calculation with it. You call reduce with the function and the initial value. Each iteration the function is called with the accumulator. The function does something with the accumulator and returns a new value for it. Once you get the hang of it, it is very powerful. Best to give an example. To sum all values:

<syntaxhighlight lang="lua"> local sum = myVar.reduce(function(acc, item)
local value = item.data
return acc + value
end, 0)</syntaxhighlight>
Suppose you want to get data points older than 45 minutes and count the values that are higher than 20 (of course there are more ways to do this):

<syntaxhighlight lang="lua"> local myVar = domoticz.data.myVar

local olderItems = myVar.filter(function (item)
return (item.time.minutesAgo > 45)
end)

local count = olderItems.reduce(function(acc, item)
if (item.data > 20) then
acc = acc + 1
end
return acc
end, 0)

print('Found ' .. tostring(count) .. ' items')</syntaxhighlight>

==== Statistical functions ====

Statistical functions require ''numerical'' data in the set. If the set is just numbers you can do this:

<pre>myVar.add(myDevice.temperature) -- adds a number to the set
myVar.avg() -- returns the average</pre>
If, however, you add more complex data or you want to do a computation first, then you have to ''tell dzVents how to get a numeric value from these data''. So let’s say you do this to add data to the set:

<pre>myVar.add( { 'person' = 'John', waterUsage = u })</pre>
Where <code>u</code> is a variable that got its value earlier. If you want to calculate the average water usage, then dzVents will not be able to do this because it doesn’t know the value is actually in the <code>waterUsage</code> attribute! You will get <code>nil</code>.

To make this work you have to provide a '''getValue function''' in the data section when you define the historical variable:

<syntaxhighlight lang="lua"> return {
active = true,
on = {...},
data = {
myVar = {
history = true,
maxItems = 10,
getValue = function(item)
return item.data.waterUsage -- return number!!
end
}
},
execute = function()...end
}</syntaxhighlight>
This function tells dzVents how to get the numeric value for a data item. '''Note: the <code>getValue</code> function has to return a number!'''.

Of course, if you don’t intend to use any of these statistical functions you can put whatever you want in the set.

<ul>
<li>'''avg( [fromIdx], [toIdx], [default] )''': Calculates the average of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''avgSince([[#Time_specification_.28timeAgo.29|timeAgo]], default )''': Calculates the average of all data points since <code>timeAgo</code>. Returns <code>default</code> if there are no data, otherwise 0. E.g.: <code>local avg = myVar.avgSince('00:30:00')</code> returns the average over the past 30 minutes.</li>
<li>'''med( [fromIdx], [toIdx], [default] )''': Calculates the median of all item values within the range <code>fromIdx</code> to <code>toIdx</code>. If no data are in the set, the value <code>default</code> will be returned instead of <code>0</code>.</li>
<li>'''min( [fromIdx], [toIdx] )''': Returns the lowest value in the range defined by fromIdx and toIdx.</li>
<li>'''minSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''min''' but now within the <code>timeAgo</code> interval.</li>
<li>'''max( [fromIdx], [toIdx] )''': Returns the highest value in the range defined by fromIdx and toIdx.</li>
<li>'''maxSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''max''' but within the <code>timeAgo</code> interval.</li>
<li>'''sum( [fromIdx], [toIdx] )''': Returns the summation of all values in the range defined by fromIdx and toIdx. It will return 0 when there are no data.</li>
<li>'''sumSince([[#Time_specification_.28timeAgo.29|timeAgo]])''': Same as '''sum''' but within the <code>timeAgo</code> interval. It will return 0 when there are no data in the interval.</li>
<li>** delta(fromIdx, toIdx, [smoothRange], [default] )**: Returns the delta (difference) between items specified by <code>fromIdx</code> and <code>toIdx</code>. Provide a valid range (no <code>nil</code> values). [Supports data smoothing]. (#Data_smoothing) when providing a <code>smoothRange</code> value. Returns <code>default</code> if there is not enough data. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta(2, 5, 3)</code>.</li>
<li>'''delta2( fromIdx, toIdx, [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''delta''' but now you can control if the smooth values for the ''from-item'' and the ''to-item'' separately. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = delta2(2, 5, 3, 3)</code>.</li>
<li>'''deltaSince([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRange], [default] )''': Same as '''delta''' but within the <code>timeAgo</code> interval. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSince('00:00:10', 3)</code>.</li>
<li>'''deltaSinceOrOldest([[#Time_specification_.28timeAgo.29|timeAgo]], [smoothRangeFrom], [smoothRangeTo], [default] )''': Same as '''deltaSince''' but it will take the oldest value in the set if ''timeAgo'' is older than the age of the entire set. The function also returns the fromItem and the toItem that is used to calculate the delta with: <code>local delta, from, to = deltaSinceOrOldest('00:00:10', 3, 3)</code>.</li>
<li>'''localMin( [smoothRange], default )''':</li>
<li>'''localMin( [smoothRange], default )''': Returns the first minimum value (and the item holding the minimal value) in the past. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value. For example, given this range of values in the data set (from new to old): <code>10 8 7 5 3 4 5 6</code>, it will return <code>3</code> because older values ''and'' newer values are higher: a local minimum. Use this if you want to know at what time a temperature started to rise after it had been dropping. E.g.:
<pre> local value, item = myVar.localMin()
print(' minimum was : ' .. value .. ': ' .. item.time.secondsAgo .. ' seconds ago' )</pre></li>
<li>'''localMax([smoothRange], default)''': Same as '''localMin''' but for the maximum value. [[#Data_smoothing|Supports data smoothing]] when providing a <code>smoothRange</code> value.</li>
<li>'''smoothItem(itemIdx, [smoothRange])''': Returns a the value of <code>itemIdx</code> in the set but smoothed by averaging with its neighbors. The number of neighbors is set by <code>smoothRange</code>. See [[#Data_smoothing|Data smoothing]].</li></ul>


==== Data smoothing ====

Example: Suppose you store temperatures in the historical variable. These temperatures may have extremes. Perhaps these extremes could be due to sensor reading errors. In order to reduce the effect of these so-called spikes, you could smooth out values. It is like blurring the data. The Raw column is your temperatures. The other columns are calculated by averaging the neighbors. For item 10 the calculations are:

<pre>Range=1 for time10 = (25 + 31 + 29) / 3 = 28,3
Range=2 for time10 = (16 + 25 + 31 + 29 + 26) / 5 = 25,4</pre>

{| class="wikitable" style="text-align: center; align="center" width="30% height:10px;"
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"| time
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| raw
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=1
! style="text-align: center; background:darkblue; color:white" align="center" width="12%"align="center" width="12%"| range=2
|-
| '''1'''
| 18
| 20,0
| 21,7
|-
| '''2'''
| 22
| 21,7
| 25,0
|-
| '''3'''
| 25
| 27,3
| 24,6
|-
| '''4'''
| 35
| 27,7
| 26,6
|-
| '''5'''
| 23
| 28,7
| 27,6
|-
| '''6'''
| 28
| 26,0
| 25,8
|-
| '''7'''
| 27
| 23,7
| 23,8
|-
| '''8'''
| 16
| 22,7
| 25,4
|-
| '''9'''
| 25
| 24,0
| 25,6
|-
| '''10'''
| 31
| 28,3
| 25,4
|-
| '''11'''
| 29
| 28,7
| 29,2
|-
| '''12'''
| 26
| 30,0
| 30,2
|-
| '''13'''
| 35
| 30,3
| 30,2
|-
| '''14'''
| 30
| 32,0
| 30,4
|-
| '''15'''
| 31
| 30,3
| 30,8
|-
| '''16'''
| 30
| 29,7
| 28,2
|-
| '''17'''
| 28
| 26,7
| 28,6
|-
| '''18'''
| 22
| 27,3
| 26,2
|-
| '''19'''
| 32
| 24,3
| 25,3
|-
| '''20'''
| 19
| 25,5
| 24,3
|}
A chart illustrates it more clearly. The red line is not smoothed and has more spikes than the others:

[[File:dzvents-smoothing.png|frame|none|alt=|Smoothing]]

Usually a range of 1 or 2 is sufficient when providing a smoothing range to statistical functions. I suggest smoothing when checking deltas, local minimums and maximums.


== How does the storage stuff work? ==

For every script file that defines persisted variables (using the <code>data={ … }</code> section), dzVents will create storage file with the name <code>__data_scriptname.lua</code> in a subfolder called <code>data</code>. You can always delete these data files or the entire storage folder if there is a problem with it:

<pre>domoticz/
scripts/
dzVents/
data/
__data_yourscript1.lua
__data_yourscript2.lua
__data_global_data.lua
examples/
generated_scripts/
scripts/
yourscript1.lua
yourscript2.lua
global_data.lua</pre>
If you dare to, you can watch inside these files. Every time some data are changed, dzVents will stream the changes back into the data files. '''Again, make sure you don’t put too much stuff in your persistent data as it may slow things down too much.'''


= Asynchronous HTTP requests =

dzVents allows you to make asynchronous HTTP request and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use os functions like <code>curl</code> or <code>wget</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz will terminate the script with a message that it took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to make an http call and it is determined by how you use the <code>domoticz.openURL()</code> command. The simplest form simply calls <code>openURL</code> on the domoticz object with only the url as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.openURL('http://domain/path/to/something?withparameters=1')</syntaxhighlight>
After your script is finished, Domoticz will make the request that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a url you pass in a table with all the parameters to make the request '''and''' your provide a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.openURL({
url = 'http://domain/path/to/something',
method = 'POST',
callback = 'mycallbackstring',
postData = {
paramA = 'something',
paramB = 'something else'
}
})
end
}</syntaxhighlight>
In this case, Domoticz will make the request (a POST in this case), and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
httpResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if (response.ok) then -- success
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every 5 seconds'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
domoticz.openURL({
url = '...',
callback = 'trigger'
})
end
if (item.isHTTPResponse) then
if (item.ok) then
...
end
end
end
}</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.openURL(options)''': ''options'' is a Lua table:

* '''url''': ''String''.
* '''method''': ''String''. Optional. Either <code>'GET'</code> (default), <code>'POST'</code>, <code>'PUT'</code>3.0.2 or <code>'DELETE'</code>3.0.2 .
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to trigger the callback handler script(s).
* '''headers''': ''Table / String''. Optional. A Lua table or JSON string with additional http request-headers.
* '''postData''': ''Table / String''. Optional. When doing a <code>POST</code>, <code>PUT</code> 3.0.2 or <code>DELETE</code>3.0.2 this data will be the payload of the request (body). If you provide a Lua table then this will automatically be converted to json and the request-header <code>application/json</code> is set. So no need to do that manually. Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': Raw response data.
* '''hasLines''': ''Boolean''. 3.1.0 When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''headers''': ''Table''. Response headers.
* '''isJSON''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'application/json'</code>. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. Short for <code>response.headers['Content-Type'] == 'text/xml'</code>. When true, the data is automatically converted to a Lua table.
* '''json'''. ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. 3.1.0 When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be in range of 200-299.
* '''statusCode''': ''Number''. HTTP status codes. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''statusText''': ''String''. HTTP status message. See [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response status codes].
* '''protocol''': ''String''. HTTP protocol. See [https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP response status codes].
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


=== More about request and response headers ===

Whenever you do an http request it is not just some data that is sent. Along with the request a bunch of so-called headers are sent along with it. HTTP headers allow the client and the server to pass additional information with the request or the response. Also, in the response there are also headers (response header). These response headers usually tell you what kind of data is returned, if it is compressed, if the request was successful etc.


==== request headers ====

dzVents allow you to set custom request headers that will accompany the data in the request. Sometimes it is necessary to set these headers like for instance when a API or webservice require a security token or key or when the service needs to know what the format of the response data is. Check the documentation of the web service.

So, let’s say you need to call a web service that requires an api key in the headers and the documentation states it needs to be passed in an x-access-token header. Your openURL command then may look like this:

<syntaxhighlight lang="lua">domoticz.openURL({
url = 'https://somedomain.com/service/getInfo',
headers = { ['x-access-token'] = '<api-key>' },
method = 'GET',
callback = 'info'
})</syntaxhighlight>
Check google for more information about request headers. All you need to know here is that dzVents allow you to set these headers.


==== response headers ====

As said earlier, the response also contains a bunch of headers. You can inspect those headers with dzVents but ususally you don’t have to. For starters, dzVents already checks the <code>Content-Type</code> header which usually states what kind of data format the response is. If it is <code>application/json</code> then it automatically converts the json data to a Lua table. Also, it checks the <code>Status</code> header to see if the request was successful. If so, then it sets the <code>ok</code> attribute on the response object. So normally you don’t have to inspect the headers. However, sometimes the web service puts a session token in the response header that you have to use in follow-up requests.

So here an example where we have to log in before we can fetch data. It uses two requests: the first performs the log-in and the second grabs the session token from the login response data and uses that token in the second request to get the data we need. In this example we do this every hour.

That would look like this:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'loggedin', 'data' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/login',
method = 'POST',
postData = { ['username'] = 'Luke Skywalker', ['password'] = 'theforce' }
callback = 'loggedin'
})
end
if (item.isHTTPResponse and item.ok) then
-- check to which request this response was the result
if (item.trigger == 'loggedin') then
-- we are logged in, now grab the session token from the header and
-- fetch our data
local token = item.headers['x-session-token']
-- now we have the token, put it in the headers:
domoticz.openURL({
url = 'https://somedomain.com/getData',
method = 'GET',
headers = { ['x-session-token'] = token },
callback = 'data'
})
else
-- it must the data we requested
local data = item.data
-- do something with it
end
end
end
}</syntaxhighlight>
Some remarks about the response header <code>Content-Type</code>. If a service is a good web-citizen then it tells you what the format of the data is in this header. So, if the data is a json object then the header should be <code>application/json</code>. Unfortunately, there are lot of lazy programmers out there who don’t set this header properly. If that is the case, dzVents cannot detect the format and will not turn it into a Lua table for you automatically. So, if you know it is json but the header is not properly set, then you can easily convert it into a Lua table in your code:

<syntaxhighlight lang="lua">return {
on = {
timer = {'every hour'},
httpResponses = { 'trigger' }
},
execute = function(domoticz, item)
if (item.isTimer) then
-- login
domoticz.openURL({
url = 'https://somedomain.com/getData',
callback = 'trigger'
})
end
if (item.isHTTPResponse and item.ok) then
-- we know it is json but dzVents cannot detect this
-- convert to Lua
local json = domoticz.utils.fromJSON(item.data)
-- json is now a Lua table
print(json.result.title) -- just an example
end
end
}</syntaxhighlight>

= Asynchronous shell command execution =

dzVents allows you to make asynchronous shell commands and handle the results. Asynchronous means that you don’t block the system while waiting for the response. Earlier you had to use functions like <code>utils.osCommand()</code> or <code>os.Execute()</code> and some magic to make sure that you didn’t block the system for too long after which Domoticz comes with a message that the script took more than 10 seconds.

dzVents to the rescue. With dzVents there are two ways to execute a shell command asynchronously and it is determined by how you use the <code>domoticz.executeShellCommand()</code> command. The simplest form simply calls <code>executeShellCommand</code> on the domoticz object with only the command as the parameter (a string value):

<syntaxhighlight lang="lua">domoticz.executeShellCommand('some shell command')</syntaxhighlight>
After your script is finished, Domoticz will execute the request in a separate thread and that’s where it ends. No callback. Nothing.

The second way is different. Instead of passing a command you pass in a table with the command to be executed '''and''' a ''callback trigger'' which is just a string or a name:

<syntaxhighlight lang="lua">return {
on = { ... }, -- some trigger
execute = function(domoticz)
domoticz.executeShellCommand({
command = 'some shell command',
callback = 'mycallbackstring',
timeout = timeoutinseconds,
})
end
}</syntaxhighlight>
In this case, Domoticz will execute the command and when done it will trigger an event. dzVents will capture that event and will execute all scripts listening for this callback trigger (''mycallbackstring''):

<syntaxhighlight lang="lua">return {
on = {
shellCommandResponses = { 'mycallbackstring' }
},
execute = function(domoticz, response)
if response.ok then
if (response.isJSON) then
domoticz.log(response.json.some.value)
end
else
domoticz.log('There was an error', domoticz.LOG_ERROR)
end
end
}</syntaxhighlight>
Of course you can combine the script that issues the request and handles the response in one script:

<syntaxhighlight lang="lua">return
{
on =
{
timer =
{
'every 5 minutes',
},
shellCommandResponses =
{
scriptVar,
},
},

execute = function(domoticz, item)
if item.isTimer then
domoticz.executeShellCommand(
{
command = 'some shell command',
callback = scriptVar,
timeout = timeoutinseconds,
})
elseif item.isShellCommandResponse then
if item.statusCode == 0 then
... -- process result (in item.json, -item.xml, -item.lines or item.data)
end
end
end
}
</syntaxhighlight>

== API ==


=== Making the request: ===

'''domoticz.executeShellCommand(options)''': ''options'' is a Lua table:

* '''command''': ''String''.
* '''callback''': ''String''. Optional. A custom string that will be used by dzVents to find a the callback handler script.
* '''timeout''': ''Integer''. Optional. Max execution time in seconds. defaults to 10 seconds. A value of 0 disables the timeout.

Supports [[#Command_options_.28delay.2C_duration.2C_event_triggering.29|command options]].


=== The response object ===

The response object (second parameter in your execute function) has these attributes:

* '''data''': output from the command. (stdout)
* '''errorText''': Errors generated by the command (stderr)
* '''statusCode''': ''Int''. exitcode generated by the command
* '''hasLines''': ''Boolean''. When true, the data is automatically converted to a Lua table. (isJSON and isXML have preference)
* '''isJSON''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''isXML''': ''Boolean''. When true, the data is automatically converted to a Lua table.
* '''json''': ''Table''. When the response data is <code>application/json</code> then the response data is automatically converted to a Lua table for quick and easy access.
* '''lines''': ''Table''. When the response data has multiple lines but is not a JSON or XML string then the response data is automatically converted to a Lua table for quick and easy access.
* '''ok''': ''Boolean''. <code>True</code> when the request was successful. It checks for statusCode to be 0.
* '''timeoutOccurred''' ''Boolean'' <code>True</code> when the request was aborted by a timeout.
* '''trigger''', '''callback''': ''String''. The callback string that triggered this response instance. This is useful if you have a script that is triggered by multiple different callback strings.
* '''xml'''. ''Table''. When the response data is <code>text/xml</code> , the response data is automatically converted to a Lua table for quick and easy access.
* '''xmlEncoding'''. ''String''. When the response data is <code>text/xml</code> See [ xml encoding] ( https://en.wikipedia.org/wiki/XML ).
* '''xmlVersion'''. ''String''. When the response data is <code>text/xml</code> See [ xml versions ] ( https://en.wikipedia.org/wiki/XML ).


= Settings =

Settings for dzVents are found in the Domoticz GUI: '''Setup > Settings > Other > EventSystem''':

* '''dzVents disabled''': Tick this if you don’t want any dzVents script to be executed.
* '''Log level''': (Note that you can override this setting in the logging section of your script)
** ''Errors'',
** ''Errors + minimal execution info'': Errors and some minimal information about which script is being executed and why,
** ''Errors + minimal execution info + generic info''. Even more information about script execution and a bit more log formatting.
** ''Debug''. Shows everything and dzVents will create the files <code>domoticzData.lua</code> and <code>module.log</code> in the scripts/dzVents folder. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz and <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.
** ''No logging''. As silent as possible.


= Troubleshooting =

So, you think if you have done everything correctly but things do not work (in some way) as you expected. Here are a couple steps you can do to find the cause.


=== Is dzVents enabled? ===

Check the settings (see above) and make sure the checkbox '''dzVents disabled''' is not checked.


=== Is your script enabled? ===

Make sure the active section in your script is set to <code>true</code>: <code>active = true</code>. And, on top of that, if you are using the internal web editor to write your script, make sure that your script is active there and you have clicked Save! “Event active” is a separate checkbox that must be ticked for every active script. When not active, the script name will be red in the list on the right.


=== Turn on debug logging ===

Activate debug logging in the settings (see above). This will produce a lot of extra messages in the Domoticz log (don’t forget to turn it off when you are done troubleshooting!). It is best to monitor the log through the command line, as the log in the browser sometimes tends to not always show all log messages. See the Domoticz manual for how to do that.

When debug logging is enabled, every time dzVents kicks into action (Domoticz throws an event) it will log it, and it will create the files <code>domoticzData.lua</code> and <code>module.log</code> in <code>/path/to/domoticz/scripts/dzVents</code>. <code>domoticzData.lua</code> is a dump of all the data received by dzVents from Domoticz. This data lie at the core of the dzVents object model. You can open this file in an editor to see if your device/variable/scene/group/hardware is in there. Note that the data in the file are not exactly the same as what you will get when you interact with dzVents, but it is a good start. If your object is not in the data file, then you will not have access to it in dzVents and dzVents will not be able to match triggers with that object. Something’s wrong if you expect your object to be in there but it is not (is the object active/used?). <code>module.log</code> is a summary of the execution time and CPU usage of the user scripts active during the debug period.with a dump of the data sent to dzVents.

Example content of <code>module.log</code>

<pre> Startdate time - End date time (clk - CPU ) dule / scriptname << type: "trigger"
---------------------------------------------------------------------------------------------------------------
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0029) waqi.lua << timer: "every 20 minutes"
11/27/20 18:40:00 - 11/27/20 18:40:00 (00 - 0.0016) Washer.lua << timer: "every 5 minutes"
11/27/20 18:40:01 - 11/27/20 18:40:01 (00 - 0.0215) getWaterFromHomewizard.lua << HTTPResponse: "WaterfromHomewizard"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.2472) updateWeatherSensors.lua << HTTPResponse: "WUS_buienradarResponse"
11/27/20 18:40:03 - 11/27/20 18:40:03 (00 - 0.0290) waqi.lua << HTTPResponse: "waqi_nearby"
11/27/20 18:41:00 - 11/27/20 18:41:00 (00 - 0.0583) Bathroom humidity.lua << timer: "every minute between 05:15 and 23:30"</pre>
Every time Domoticz starts dzVents and debug logging is enabled you should see these lines in the domoticz log:

<pre>dzVents version: x.y.z
Event trigger type: aaaa</pre>
Where aaaa can be time, custom event, system event, device, uservariable, security or scenegroup. That should give you a clue what kind of event is active. If you don’t see this information then dzVents is not active (or debug logging is not active).


=== Script is still not executed ===

If for some reason your script is not executed while all of the above is done, it is possible that your triggers are not correct. Either the time rule is not matching with the current time (try to set the rule to <code>every minute</code> or something simple), or the device name is not correct (check casing), or you use an id that doesn’t exist. Note that in the <code>on</code> section, you cannot use the dzVents domoticz object!

Make sure that if you use an id in the <code>on</code> section that this id is correct. Go to the device list in Domoticz and find the device and make sure the device is in the ‘used’ list!. Unused devices will not create an event. Find the idx for the device and use that as the id.

Also, make sure that your device names are unique! dzVents will throw a warning in the log if multiple device names match. It’s best practice to have unique names for your devices. Use some clever naming like prefixing like ‘Temperature: living room’ or ‘Lights: living room’. That also makes using wild cards on your <code>on</code> section easier.

If your script is still not triggered, you can try to create a classic Lua event script and see if that does work.


=== Debugging your script ===

A simple way to inspect a device in your script is to dump it to the log: <code>myDevice.dump()</code>. This will dump everything known to dzVents of the device so you can inspect what its state is. If you only need to see a subset you can use dumpSelection(‘attributes’), dumpSelection(‘functions’) or dumpSelection(‘tables’) Use print statements or domoticz.log() statements in your script at cricital locations to see if the Lua interpreter reaches that line. Don’t try to print a device object though; use the <code>myDevice.dump()</code> method for that. It wil log all attributes of the device in the Domoticz log.

If you place a print statement all the way at the top of your script file it will be printed every time dzVents loads your script (that is done at the beginning of each event cycle). Sometimes that is handy to see if your script gets loaded in the first place. If you don’t see your print statement in the log, then likely dzVents didn’t load it and it will not work.


=== Get help ===

The Domoticz forum is a great resource for help and solutions. Check the [https://www.domoticz.com/forum/viewforum.php?f=59 dzVents forum].


= Other interesting stuff =


== lodash for Lua ==

lodash is a well known and very popular Javascript library filled with dozens of handy helper functions that really make you life a lot easier. Fortunately there is also a Lua version. This is directly available through the domoticz object:

<syntaxhighlight lang="lua">local _ = domoticz.utils._
_.print(_.indexOf({2, 3, 'x', 4}, 'x'))</syntaxhighlight>

Check out the documentation [https://htmlpreview.github.io/?https://github.com/rwaaren/lodash.lua/blob/master/doc/index.html here].


= History [https://wiki.domoticz.com/DzVents_version_History link to changes in previous versions]. =

See link for the complete list of changes

https://wiki.domoticz.com/DzVents_version_History

DzVents automation wizard

2026-07-10T09:18:19Z

Walter vl:

The '''Domoticz Automation Wizard''' is a built-in step-by-step UI tool allowing you to create <code>dzVents</code> Lua scripts without writing code. Accessible via the Events Editor, it guides you through selecting triggers, conditions, and actions. The tool automatically translates these parameters into readable, underlying code.

== How to Access the Wizard ==

# Open your '''Domoticz dashboard''' and navigate to <code>Setup</code> → <code>More Options</code> → <code>Events</code>. (see als wiki [[Events]])
# Click the '''+ button''' to create a new script.
# Select '''dzVents''' and launch the '''Automation Wizard'''.

[[File:Dzventsautomationwizard.png]]

== How it Works (UI Steps) ==

* '''Trigger Selection:''' Define what activates the script (e.g., a specific device turning On, a security panel state change, or a time schedule).
* '''Configuration:''' Establish exactly which device or condition to evaluate.
* '''Action Setup:''' Determine the outcome (e.g., toggle another light, send a notification).
* '''Review & Output:''' The wizard dynamically generates the proper [[DzVents: next generation Lua scripting|<code>dzVents</code> syntax]], minimizing potential syntax errors.

== Typical Use Cases ==

* Linking a motion detector to a smart plug while factoring in room temperature or lux constraints.
* Setting up automatic sunset and sunrise schedules.
* Sending automated alerts if a door sensor changes state

Automation

2026-07-10T07:30:56Z

Walter vl: /* Events system scripts */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
=Introduction=

This page gives an overview of different methods of automation for devices to act on input from sensors or switches.

=Scenes and Groups=
What is the difference between Scenes and Groups:

*A "Group" is a set you can turn on or off together. Like a big extension cord with a power switch. They all go on or off. But every device can switch on with different characteristics like dim level, color etc.
*A "Scene" is a predefined setup of lights and devices. So you can setup 1 light to be on, another to off. Have the ledstrip/milight set to a nice blue color, close your curtains, switch on your radio on station Xyz. That's also why you can't switch a scene off, but only to on. You will have to make an extra scene (or group) to switch the devices off.

So for example a group is used to turn all lights off when you leave the house.

And a scene is used when you have a nice setup of lightning you want when you are going to watch a movie.

For more instructions go to page [[Managing Devices#Scenes .28also for Groups.29|Managing devices - Scenes and Groups]]

=Timers=
Each switch, group, scene or thermostat device can be activated by timers to change the status or for thermostats, the setpoint temperature.

There can be more timers per switch/thermostat so you can make a complete schedule. They also make part of a [[Timer Plan|timer plan]] so you can set up for example a holiday schedule for your lights.

The timer options are partly dependent of the switch type and Timer type. There are lots of timer types like "x minutes after sunset", monthly, even day numbers, daily at time xx:xx etc.

See for more instructions page [[Managing Devices#Edit Device Timers|Managing Devices - Edit Device Timers]]
=Notifications=
There are a great selection of notification types so it's possible to do some interesting things with this but chances are any of those interesting things should go under the action scripts.

This option is available on the Switches screen when you select a switch to work with.

See also the [[Application Settings|Application Settings, section Notifications]] for general setup of notifications and page [[Managing Devices#Edit Notifications|Managing Devices - Edit Notifications]] for creating device notifications.

=Scripts=
For more complex automation scripts can be used.

You have a choice of [[Blockly]], Python, [[LUA commands|LUA]] or [[DzVents: next generation Lua scripting|dzVents]]. Blockly is the easiest way to start. You'll get more power with dzVents.

Please see the [[Scripting in Domoticz|scripting]] details on how to use either of these scripting methods.

==Devices Action Scripts==
[[File:2015-08-21 12 26 41-Domoticz.png|frame]]Devices (Switches) have an ''On Action'' and ''Off Action'' option that allows you to run a script either via a URL or via the script folder. This will be discussed in the [[Scripting in Domoticz|script page]].
To get to these you need to edit a switch.

See also page [[Managing Devices]]

==Events system scripts==
Domoticz allows you to write scripts in the Web-Interface just go to the e [[Events|Event system]]:

'''Setup -> More Options -> Events''' in this view you see a "+" sign in a tab to choose what script you want to write.

;Script Method
:You have a choice of [[Blockly]], [[Python Events|Python]], [[LUA commands|LUA]] or [[DzVents: next generation Lua scripting|dzVents]]. Blockly is the easiest way to start. You'll get more power with dzVents but Blockly is a great place to start!

==== DzVents automation wizard ====
In 2026.2 the [[DzVents automation wizard]] has been introduced which makes it easier to create the dzvents scripts, no code required.
;[[Events|For more info on the event sytem check wifi page Event system]]
;[[File:Events_user_interface.png|none|frame|[[File:Blockly example.png|alt=|left]]]]

==Lua, Python and DzVents File System Based==
For technical users that want to write complicated scripts and include additional Lua, DzVents or Python modules and scripts, Domoticz also supports file-based scripts. These are not included in the Domoticz standard Backup & Restore functions and are not versioned so this needs to be done manually. For more info check page [[Scripting in Domoticz]]
 
=Continue to the next page of the introduction=
[[Scripting_in_Domoticz| Scripts]]

 
[[Category:Domoticz]]
[[Category:Manual]]

Automation

2026-07-10T07:29:51Z

Walter vl: /* Events system scripts */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
=Introduction=

This page gives an overview of different methods of automation for devices to act on input from sensors or switches.

=Scenes and Groups=
What is the difference between Scenes and Groups:

*A "Group" is a set you can turn on or off together. Like a big extension cord with a power switch. They all go on or off. But every device can switch on with different characteristics like dim level, color etc.
*A "Scene" is a predefined setup of lights and devices. So you can setup 1 light to be on, another to off. Have the ledstrip/milight set to a nice blue color, close your curtains, switch on your radio on station Xyz. That's also why you can't switch a scene off, but only to on. You will have to make an extra scene (or group) to switch the devices off.

So for example a group is used to turn all lights off when you leave the house.

And a scene is used when you have a nice setup of lightning you want when you are going to watch a movie.

For more instructions go to page [[Managing Devices#Scenes .28also for Groups.29|Managing devices - Scenes and Groups]]

=Timers=
Each switch, group, scene or thermostat device can be activated by timers to change the status or for thermostats, the setpoint temperature.

There can be more timers per switch/thermostat so you can make a complete schedule. They also make part of a [[Timer Plan|timer plan]] so you can set up for example a holiday schedule for your lights.

The timer options are partly dependent of the switch type and Timer type. There are lots of timer types like "x minutes after sunset", monthly, even day numbers, daily at time xx:xx etc.

See for more instructions page [[Managing Devices#Edit Device Timers|Managing Devices - Edit Device Timers]]
=Notifications=
There are a great selection of notification types so it's possible to do some interesting things with this but chances are any of those interesting things should go under the action scripts.

This option is available on the Switches screen when you select a switch to work with.

See also the [[Application Settings|Application Settings, section Notifications]] for general setup of notifications and page [[Managing Devices#Edit Notifications|Managing Devices - Edit Notifications]] for creating device notifications.

=Scripts=
For more complex automation scripts can be used.

You have a choice of [[Blockly]], Python, [[LUA commands|LUA]] or [[DzVents: next generation Lua scripting|dzVents]]. Blockly is the easiest way to start. You'll get more power with dzVents.

Please see the [[Scripting in Domoticz|scripting]] details on how to use either of these scripting methods.

==Devices Action Scripts==
[[File:2015-08-21 12 26 41-Domoticz.png|frame]]Devices (Switches) have an ''On Action'' and ''Off Action'' option that allows you to run a script either via a URL or via the script folder. This will be discussed in the [[Scripting in Domoticz|script page]].
To get to these you need to edit a switch.

See also page [[Managing Devices]]

==Events system scripts==
Domoticz allows you to write scripts in the Web-Interface just go to the e [[Events|Event system]]:

'''Setup -> More Options -> Events''' in this view you see a "+" sign in a tab to choose what script you want to write.

;Script Method
:You have a choice of [[Blockly]], [[Python Events|Python]], [[LUA commands|LUA]] or [[DzVents: next generation Lua scripting|dzVents]]. Blockly is the easiest way to start. You'll get more power with dzVents but Blockly is a great place to start!
;
;[[Events|For more info check wifi page Event system]]
;[[File:Events_user_interface.png|none|frame|[[File:Blockly example.png|alt=|left]]]]

==Lua, Python and DzVents File System Based==
For technical users that want to write complicated scripts and include additional Lua, DzVents or Python modules and scripts, Domoticz also supports file-based scripts. These are not included in the Domoticz standard Backup & Restore functions and are not versioned so this needs to be done manually. For more info check page [[Scripting in Domoticz]]
 
=Continue to the next page of the introduction=
[[Scripting_in_Domoticz| Scripts]]

 
[[Category:Domoticz]]
[[Category:Manual]]

Events

2026-07-10T07:24:08Z

Walter vl: /* dzVents Interface */

The Event System handles scripts/actions that are activated on triggers like device changes, security events, time, user variables etc

Domoticz will execute all time, variable and device triggers when the relevant trigger occurs, e.g. the device scripts are run when a device changes, the variable scripts are run when a variable changes, the time scripts will run every minute. Also scripts don't run in background. Domoticz will wait for the script to complete so don't use sleep() statements and get the script done as fast as possible. Also be aware of time consuming (external) actions like getting solar panel data from an internet portal that can block the throughput of other events in Domoticz.

The event system will have two options to create events:

==Using script creation & editing functionality within Domoticz itself==

You can find the interface here: '''Setup -> More options -> Events'''.

The Events page has 2 sections:

#'''My automation scripts'''. A list of all your scripts (enabled or disabled) stored in the database.
#'''Editor''' Here you can create and edit your scripts.It has minimal 2 tabs, when adding a script it will be added to the tabs
##'''Device current state list''' Here all your devices are listed with the current value so you do not have to switch to the device list in Setup-Devices. There is a Refresh button to update the statuses.
##'''Add script (+ sign)'''. The Editor/Event Engine that will be used for the script. Drop down values:
##*Blockly
##*Python
##*Lua With drop down list for event type
##*dzVents With drop down list for event type
##*'''Event Type'''. Controls what events events will cause Domoticz to execute the script. Drop down values:
##*#All - Will run whenever anything happens that triggers the event system to run a script
##*#Device - Will run whenever ANY device state/value change
##*#Security - Will run whenever there is a security event
##*#Time - Will run once per minute. Scripts are executed one at a time.
##*#User Variable - Will run when User Variables are updated
##*#dzVents has more event types, [[DzVents: next generation LUA scripting|see the documentation]]

Event scripts can be enabled or disabled using the "On/Off" checkbox. Disabled events are marked red in the events list.

Event scripts can be saved with the Save button and be deleted with the Delete button.

Scripts will be stored in the Domoticz database itself so do not need to be backed up separately.

[[File:Events user interface.png]]

===Devices Current states Tab===
In this Tab you can see the current state and values of all devices in the Domoticz environment.

With the button Refresh these states and values are refreshed.

[[File:Events Device status.png]]

===The "Blockly" interface===

For getting started with [[Blockly]] go to its wiki page [[Blockly]].

[[File:Blockymonday.PNG]]

Domoticz examples can be found in the forum: http://www.domoticz.com/forum/viewtopic.php?f=15&t=31

===dzVents Interface===
[[DzVents: next generation Lua scripting|DzVents]] short for Domoticz Easy Events, brings Lua scripting in Domoticz to a whole new level. Writing scripts for Domoticz has never been so easy. Not only can you define triggers more easily, and have full control over timer-based scripts with extensive scheduling support, dzVents presents you with an easy to use API to all necessary information in Domoticz. No longer do you have to combine all kinds of information given to you by Domoticz in many different data tables. You don’t have to construct complex commandArrays anymore. dzVents encapsulates all the Domoticz peculiarities regarding controlling and querying your devices. And on top of that, script performance has increased a lot if you have many scripts because Domoticz will fetch all device information only once for all your device scripts and timer scripts.

By creating scripts inside Domoticz using the internal Domoticz event editor. To create a new dzVents script:

#Go to '''Setup > More Options > Events'''.
#Press the + button and choose '''dzVents'''.
#You must then choose a template on event type

They are there just for convenience during writing the script; the actual trigger for the script is determined by what you entered in the on = section. The internal event editor have a help button when writing dzVents scripts, next to Save and Delete. This button opens this wiki in a separate browser tab when clicked. Name your script to your liking but leave out the extension .lua

Check out [[DzVents: next generation Lua scripting]] for instructions how to use DzVents including extensive documentation.

==== DzVents automation wizard ====
In 2026.2 the [[DzVents automation wizard]] has been introduced which makes it easier to create the dzvents scripts, no code required.

[[File:Dzventsautomationwizard.png]]

===Lua Interface===

Lua events maintain through the editor work in the way that file based Lua scripts do and use the same 'commandArray' interface. There are samples and help on this Wiki. Currently Python is only an option if Domoticz is built from source with Python enabled.

The Lua editor is context sensitive and will prompt with auto-complete options and show common errors to help with debugging. The editor theme can be changed by pressing the control and comma keys at the same time. Domoticz will save the scheme when events are saved.

To create a new Lua event:

#Go to '''Setup > More Options > Events'''.
#Press the + button and choose '''Lua'''.
#You must then choose a template on event type

A template script will be shown that shows one way of processing that type of event.

The [[LUA_commands]] page has more information on the available commands that can be passed back to Domoticz. 
===Python Interface===
Python events maintain through the editor work in the way that file based Lua scripts do and use the same 'commandArray' interface. This python event system has limited functionality, it can only switch devices On/Off, no other update parameters are available.

Currently Python is only an option if Domoticz is built from source with Python enabled (but enabled as default)

The Python editor is context sensitive and will prompt with auto-complete options and show common errors to help with debugging. The editor theme can be changed by pressing the control and comma keys at the same time. Domoticz will save the scheme when events are saved.

To create a new Python event:

#Go to '''Setup > More Options > Events'''.
#Press the + button and choose '''Python'''.
#You must then choose a template on event type

A template script will be shown that shows one way of processing that type of event.

The [[Python Events]] page has more information on the available commands that can be passed back to Domoticz.

===User Variables===
You can use [[User variables]] to store your custom values to be used in scripts.

 

===Text Editor Default Keyboard Shortcuts===
The build in Text Editor (ACE) has some handy short cuts. They are all listed here https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts

Some Examples:
 

====Line Operations====
{| class="wikitable"
!Windows/Linux
!Mac
!Action
|-
|Ctrl-D
|Command-D
|Remove line
|-
|Alt-Shift-Down
|Command-Option-Down
|Copy lines down
|-
|Alt-Shift-Up
|Command-Option-Up
|Copy lines up
|-
|Alt-Down
|Option-Down
|Move lines down
|-
|Alt-Up
|Option-Up
|Move lines up
|-
|Alt-Delete
|Ctrl-K
|Remove to line end
|-
|Alt-Backspace
|Command-Backspace
|Remove to linestart
|-
|Ctrl-Backspace
|Option-Backspace, Ctrl-Option-Backspace
|Remove word left
|-
|Ctrl-Delete
|Option-Delete
|Remove word right
|-
| ---
|Ctrl-O
|Split line
|}

====Selection====
{| class="wikitable"
!Windows/Linux
!Mac
!Action
|-
|Ctrl-A
|Command-A
|Select all
|-
|Shift-Left
|Shift-Left
|Select left
|-
|Shift-Right
|Shift-Right
|Select right
|-
|Ctrl-Shift-Left
|Option-Shift-Left
|Select word left
|-
|Ctrl-Shift-Right
|Option-Shift-Right
|Select word right
|-
|Shift-Home
|Shift-Home
|Select line start
|-
|Shift-End
|Shift-End
|Select line end
|-
|Alt-Shift-Right
|Command-Shift-Right
|Select to line end
|-
|Alt-Shift-Left
|Command-Shift-Left
|Select to line start
|-
|Shift-Up
|Shift-Up
|Select up
|-
|Shift-Down
|Shift-Down
|Select down
|-
|Shift-PageUp
|Shift-PageUp
|Select page up
|-
|Shift-PageDown
|Shift-PageDown
|Select page down
|-
|Ctrl-Shift-Home
|Command-Shift-Up
|Select to start
|-
|Ctrl-Shift-End
|Command-Shift-Down
|Select to end
|-
|Ctrl-Shift-D
|Command-Shift-D
|Duplicate selection
|-
|Ctrl-Shift-P
| ---
|Select to matching bracket
|}

====Find/Replace====
{| class="wikitable"
!Windows/Linux
!Mac
!Action
|-
|Ctrl-F
|Command-F
|Find
|-
|Ctrl-H
|Command-Option-F
|Replace
|-
|Ctrl-K
|Command-G
|Find next
|-
|Ctrl-Shift-K
|Command-Shift-G
|Find previous
|}
 

==By adding your own scripts to the scripts/lua/ dir in your domoticz installation folder.==

'''Note: '''''The power of Domoticz and Lua can be generalised by writing [[Smart Lua Scripts]], this method of combining a switch naming convention and a Lua script, allows a simple script to be used multiple times and simplifies both the addition and maintenance of further devices.''

The lua scripts folder has two demo scripts that can serve as a starting point. The script filename has 3 components each sub-divided by an underscore : <code>script_trigger_name.lua</code>

Trigger can be 'time', 'device', 'variable' or 'security', name can be any string for your reference, script_device_MyOtherDeviceNameOnWhenMyDeviceNameOn.lua for instance.

Domoticz will execute all time, variable and device triggers when the relevant trigger occurs, e.g. the device scripts are run when a device changes, the variable scripts are run when a variable changes, the time scripts will run every minute. Also scripts don't run in background. Domoticz will wait for the script to complete so don't use sleep() statements and get the script done as fast as possible.

Domoticz ignores all scripts named "demo" and scripts without the .lua extension, so copy the examples and change the name.

Make sure that if you are using non-ansi characters you save the file in UTF-8 encoding, without a BOM header

 

===LUA Scripts===
The [[LUA_commands]] page has more information on the available commands that can be passed back to Domoticz.

====Tables====

=====Available in time triggered scripts=====
<syntaxhighlight lang="lua">
timeofday
uservariables
uservariables_lastupdate

globalvariables

otherdevices
otherdevices_idx
otherdevices_lastlevel
otherdevices_lastupdate
otherdevices_svalues

-- Below tables only when such devices exist on your system. (else nil)
otherdevices_barometer
otherdevices_dewpoint
otherdevices_humidity
otherdevices_rain
otherdevices_rain_lasthour
otherdevices_temperature
otherdevices_utility
otherdevices_weather
otherdevices_winddir
otherdevices_windgust
otherdevices_windspeed
otherdevices_zwavealarms

otherdevices_scenesgroups
otherdevices_scenesgroups_idx
</syntaxhighlight>

=====Tables available in device triggered scripts=====

All of the tables available in device triggered scripts
<syntaxhighlight lang="lua">
devicechanged
devicechanged_ext
</syntaxhighlight>

=====Tables available in variable triggered scripts=====

All of the tables available in variable triggered scripts
<syntaxhighlight lang="lua">
uservariablechanged
</syntaxhighlight>

=====Use of Tables=====
The ''devicechanged'' table contains a devicename entry, indicating the new state for the device that triggered the device event:
<syntaxhighlight lang="lua">
devicechanged['devicename']='Status', e.g. devicechanged['MyLamp']='On'
</syntaxhighlight>
if the device that triggered a device-event measures temperature, humidity or barometric pressure, there will obviously not be a devicechanged['devicename']='Status' value because these values are analogue and not digital (on or off).
Instead, the value type is appended (added) to the devicename and can be checked as follows:
<syntaxhighlight lang="lua">
devicechanged['devicename_Temperature'] = value
devicechanged['devicename_Humidity'] = value
devicechanged['devicename_Barometer'] = value
</syntaxhighlight>
The whole string (devicename + type) is case sensitive, value type should start with uppercase. If your thermometer is named "MyThermometer", check its incoming temperature value by stating something like "if devicechanged['MyThermometer_Temperature'] > 20 then". If you're not sure which values are coming in:
<syntaxhighlight lang="lua">
for i, v in pairs(devicechanged) do print(i, v) end
</syntaxhighlight>
The ''otherdevices'' table contains the status for all other devices, e.g.: <code>otherdevices['yourotherdevicename']='On'</code>. When a script is triggered by time, there will be no devicechanged value, so use otherdevices to access device states.

The o''therdevices_lastupdate'' table contains the date + time of last update for all other devices, e.g.:

<code>otherdevices_lastupdate['Door'] = '2013-07-10 18:14:32'</code>

Temperature, humidity and barometer values for other devices can be found in otherdevices_temperature['yourdevice'],otherdevices_humidity['yourdevice'] and otherdevices_barometer['yourdevice'] tables.

The ''otherdevices_idx'' table contains the indexes for devices (which can be seen in 'Devices' tab, used in json sequests etc)

<code>otherdevices_idx['Door'] = 42</code>

To modify an otherdevice value, you should use commandArray['UpdateDevice']='idx|nValue|sValue' where idx is the device index, nValue and sValue the values to modify (see json page for details - [[Domoticz API/JSON URL's]])

For using user variables in Lua scripts, there are three tables available: ''uservariables, uservariables_lastupdate'' and ''uservariablechanged''. The uservariablechanged table (with only the variable that triggered the event) is only available in your event scripts (script_variable_name.lua), the other two are always available. Reference your variable by name, e.g. if uservariables["MyVar"] = ...

====commandArray====
Each script has to return a commandArray, which is filled based on succesful execution of your script. Commands in the commandArray will only be executed after the array has been returned back to Domoticz to be executed at the end of the script. This means that is is not possible to have one Lua script do multiple actions on the same device.

Using the 3 or 2 tables (depending on event type), build your own event logic, for instance:

<syntaxhighlight lang="lua">
commandArray = {}
if (devicechanged['MyDeviceName'] == 'On' and otherdevices['MyOtherDeviceName'] == 'Off') then
commandArray['MyOtherDeviceName']='On'
end
return commandArray
</syntaxhighlight>
Put device names and states between the square brackets exactly like they appear in Domoticz, the string is case sensitive and spaces need to be included e.g. devicechanged['Blue Light'].

When adding device states to the command array, choose the required command for your device, e.g. 'On', 'Off', 'Group On', etc. For dimmable devices, use command 'Set Level X' where X is a percentage (0-100) integer (do not put a percentage symbol after the value). There are three ways to set a device state. The most basic one is to just specify the new state (e.g. On/Off), which will set the new state immediately when the script logic evaluates to true.

It is also possible to change the state for a device for a fixed period of time; if the device only needs to be turned on for 10 minutes, use 'On FOR 10'.

To add a randomized timer to a device change, for instance to turn on a device somewhere in the next 30 minutes, use 'On RANDOM 30'. FOR and RANDOM are in minutes.

To change the state for a device after a fixed period of time; if the device only needs to be turned on after 10 seconds, use 'On AFTER 10'. AFTER is in seconds and accepts 3 seconds at least. ('On AFTER 2' doesn't work).

You can schedule severals commands. In this example , the testSwitch will go On after 5 seconds , and then goes On again 10 seconds after. (and not 15 seconds after ...)
<syntaxhighlight lang="lua">
commandArray[#commandArray + 1] = {['testSwitch'] ='On AFTER 5' }
commandArray[#commandArray + 1] = {['testSwitch'] ='On AFTER 15' }
</syntaxhighlight>

The keywords FOR , RANDOM, AFTER must be written in CAPITAL LETTER.

To switch a '''scene or group''', put prefix 'Scene:' or 'Group:' in front of the scene name. Note that it is not possible to check the state of a scene or group, since that is not its intended use. Check a (significant) single device from the scene/group table before switching scenes. Scenes can only be turned on, groups can be turned on and off. It is also possible to activate or deactivate a group or scene schedule by using 'Active' or 'Inactive'. This for instance enables the activation of presence simulation; when an alarm device is activated, also activate lighting schedules to simulate presence.

====Notifications====
Using the 'SendNotification' command a message can be sent to email or the notification system, whichever is set in Domoticz preferences. 
Use a # to separate subject, message body, priority and sound (pushover only). 
 
Priority values: 
-2 Low (Not available on Pushover) 
-1 Moderate (Prowl/NMA) Quiet (Pushover) 
0 Normal 
1 High (Prowl/NMA) bypasses quiet hours (Pushover) 
2 Emergency (Prowl/NMA) requires confirmation (Pushover) 
The Pushover system also supports different sounds. See [https://pushover.net/api#sounds]

====CommandArray Examples====

Using 'OpenURL' it is possible to trigger a url/api based on an event. The url will not retrieve/parse any data, use it for one way communication.

By prepending "Variable:" an existing variable can be updated.

Some valid examples:
<syntaxhighlight lang="lua">
commandArray['Switch']='On'
commandArray['Blinds']='Close'
commandArray['Scene:Livingroom']='On' -- remember, Scene cannot be turned Off!
commandArray['Group:Kitchen']='Inactive'
commandArray['Keyfob']='Group On'
commandArray['DimmableDevice']='Set Level 50'
commandArray['Selector']='Set Level: 50'
commandArray['SendNotification']='subject#body#0'
commandArray['SendEmail']='subject#body#your@email.com'
commandArray['OpenURL']='www.yourdomain.com/api/movecamtopreset.cgi'
commandArray['Blinds']='Open RANDOM 30'
commandArray['Porch Light']='On FOR 2'
commandArray['Variable:MyVar']='Some value'
commandArray['Variable:MyVar']='Some value AFTER 3'
commandArray[textDeviceIdx] = { ['UpdateDevice'] = textDeviceIdx..'|0|'..'some text' }
commandArray[tempDeviceIdx] = { ['UpdateDevice'] = tempDeviceIdx..'|0|'..temp }
commandArray[tempHumDevIdx] = { ['UpdateDevice'] = tempHumDevIdx..'|0|'.. temp ..';'.. hum ..';'.. hum_stat }
</syntaxhighlight>
-- ... (see json page [[Domoticz API/JSON URL's]] for exact number of arguments)

In device scripts, *always* do a check on the state of the changed device first. The device scripts are triggered fairly often, especially when you have a lot of thermometers and other measurement devices. If you just set the commandArray without any conditions, the script always just execute those commands at every device change, and those changes will trigger the scripts again and again resulting in a loop.

The same event will not fire unless the previous one completes. If an action is set using "Set FOR x minutes" or "RANDOM within x minutes", the same event will not schedule until the first one completes.

Using time conditions:
<syntaxhighlight lang="lua">
time = os.date("*t")
commandArray = {}
if (devicechanged['MyDeviceName'] == 'On' and otherdevices['MyOtherDeviceName'] == 'Off' and time.hour >= 22) then
commandArray['MyOtherDeviceName']='On'
end
return commandArray
</syntaxhighlight>
For checking day- or nighttime use the timeofday array with boolean variables "Daytime" and "Nighttime":
<syntaxhighlight lang="lua">
if (timeofday['Nighttime']) then
print('its nighttime')
end
</syntaxhighlight>
If you want sunrise or sunset in a numeric value, use timeofday['SunriseInMinutes'] and timeofday['SunsetInMinutes']. So when sunrise is at 7:13, timeofday['SunriseInMinutes'] will be 433.

Note: start each "commandArray" line with a tab to indent it under the "if" statement. You can give multiple commands by specifying multiple command array entries:
<syntaxhighlight lang="lua">
commandArray = {}
if (devicechanged['MyDeviceName'] == 'On' and otherdevices['MyOtherDeviceName'] == 'Off') then
commandArray['MyOtherDeviceName1']='On'
commandArray['MyOtherDeviceName2']='On'
commandArray['MyOtherDeviceName3']='Off'
commandArray['Scene:MyScene']='On'
commandArray['SendNotification']='subject#body#0'
commandArray['OpenURL']='www.yourdomain.com/api/movecamtopreset.cgi'
commandArray['Variable:MyVar']='Some value'
end
return commandArray
</syntaxhighlight>
The Lua print command will output its statements to the domoticz log, so you can use that to check on values or your logic. For instance, if you want to check the other device states that get passed into Lua, add line:
<syntaxhighlight lang="lua">
for i, v in pairs(otherdevices) do print(i, v) end
</syntaxhighlight>
Make sure to disable it after debugging as it clutters the log.

The commandArray also supports nested tables to send the same command type multiple times. To do this, give the command a numeric index (not alphanumeric with or without quotes!) and place the required action in a nested table:
<syntaxhighlight lang="lua">
commandArray = {}
commandArray[1]={['OpenURL']='www.cam1.com/api/movecamtopreset.cgi' }
commandArray[2]={['OpenURL']='www.cam2.com/api/movecamtopreset.cgi' }
commandArray[3]={['OpenURL']='www.cam3.com/api/movecamtopreset.cgi' }
return commandArray
</syntaxhighlight>
This will run three url commands with separate addresses. Always start the commandarray index at 1; Lua uses 1 based indexes, so commandArray[0] will not run.

Some examples (not meaningful, just to explain what will happen):
<syntaxhighlight lang="lua">
commandArray = {}
commandArray['Lamp']='On'
commandArray[1]={['Lamp']='On'}
commandArray[2]={['Lamp']='On'}
commandArray[3]={['Lamp']='On'}
commandArray['Lamp']='On'
return commandArray
</syntaxhighlight>
This will turn "Lamp" on 4 times (the last array item overwrites the first).
<syntaxhighlight lang="lua">
commandArray = {}
commandArray['Lamp']='On'
commandArray[0]={['Lamp']='On'}
commandArray[1]={['Lamp']='On'}
commandArray[2]={['Lamp']='On'}
commandArray['Lamp']='On'
return commandArray
</syntaxhighlight>
This will turn "Lamp" on 3 times (the last array item overwrites the first and the zero index is ignored).

Tips : Use this usefull form instead of counting the number of commands
<syntaxhighlight lang="lua">
commandArray[#commandArray + 1] = ...
commandArray[#commandArray + 1] = ...
</syntaxhighlight>

Current state of the event system:

- Not all device states are correctly passed to Lua at the moment, but the most common ones like On/Off, Open/Closed are.
- There is no check on the command in the commandArray. When you return commandArray['Kitchen light']="Up", we will not indicate that kitchen lights aren't meant to go up. Make sure you pass a valid command for the device.

Unfortunately, Domoticz doesn't report which device changed state thereby causing a script_device_xx.lua script to run. However the devicechanged table gives the game away. The following can be used to identify which device was the culprit so include it at the beginning of your device scripts:
<syntaxhighlight lang="lua">
logging = true
d = otherdevices
device = ""
for i, v in pairs(devicechanged) do
if (#device == 0 or #i < #device) then device = i end
end
if (logging) then print("Triggered by " .. device .. " now " .. d[device]) end
</syntaxhighlight>
Subsequently, you can use something like the following to decide what to do next:
<syntaxhighlight lang="lua">
if (device == "PIR_1" or device == "PIR_2" or device == "PIR_3") then
if (d[device] == "Motion" and not globalvariables["Security"] == "Disarmed" ) then
whatever
end
return commandArray
end

if (device == "Keyfob" and d[device] == "On") then
whatever
return commandArray
end
</syntaxhighlight>
... and so on

The power of Domoticz and Lua can be generalised by writing [[Smart Lua Scripts]], this method of combining a switch naming convention and a Lua script, allows a simple script to be used multiple times and simplifies both the addition and maintenance of further devices.

Post any issues here: <http://www.domoticz.com/forum/viewtopic.php?f=6&t=6>

==Event Script Examples==
Lua Example scripts here: [[Event script examples]]

Wiki page with examples: [[Scripts]]

Post Lua script examples and discussion here: <http://www.domoticz.com/forum/viewtopic.php?f=4&t=39>

Post your own Blockly examples in forum: <http://www.domoticz.com/forum/viewtopic.php?f=4&t=31>

Post your own DzVents examples in forum: <https://www.domoticz.com/forum/viewforum.php?f=72>

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]
[[Category:Blockly]]
[[Category:Lua]]
[[Category:Python]]
[[Category:Scripting‏‎]]

DzVents automation wizard

2026-07-10T07:18:40Z

Walter vl: /* How it Works (UI Steps) */

The '''Domoticz Automation Wizard''' is a built-in step-by-step UI tool allowing you to create <code>dzVents</code> Lua scripts without writing code. Accessible via the Events Editor, it guides you through selecting triggers, conditions, and actions. The tool automatically translates these parameters into readable, underlying code.

== How to Access the Wizard ==

# Open your '''Domoticz dashboard''' and navigate to <code>Setup</code> → <code>More Options</code> → <code>Events</code>.
# Click the '''+ button''' to create a new script.
# Select '''dzVents''' and launch the '''Automation Wizard'''.

[[File:Dzventsautomationwizard.png]]

== How it Works (UI Steps) ==

* '''Trigger Selection:''' Define what activates the script (e.g., a specific device turning On, a security panel state change, or a time schedule).
* '''Configuration:''' Establish exactly which device or condition to evaluate.
* '''Action Setup:''' Determine the outcome (e.g., toggle another light, send a notification).
* '''Review & Output:''' The wizard dynamically generates the proper [[DzVents: next generation Lua scripting|<code>dzVents</code> syntax]], minimizing potential syntax errors.

== Typical Use Cases ==

* Linking a motion detector to a smart plug while factoring in room temperature or lux constraints.
* Setting up automatic sunset and sunrise schedules.
* Sending automated alerts if a door sensor changes state

DzVents automation wizard

2026-07-10T07:17:37Z

Walter vl: Created page with "The '''Domoticz Automation Wizard''' is a built-in step-by-step UI tool allowing you to create <code>dzVents</code> Lua scripts without writing code. Accessible via the Events Editor, it guides you through selecting triggers, conditions, and actions. The tool automatically translates these parameters into readable, underlying code. == How to Access the Wizard == # Open your '''Domoticz dashboard''' and navigate to <code>Setup</code> → <code>More Options</code> → <c..."

The '''Domoticz Automation Wizard''' is a built-in step-by-step UI tool allowing you to create <code>dzVents</code> Lua scripts without writing code. Accessible via the Events Editor, it guides you through selecting triggers, conditions, and actions. The tool automatically translates these parameters into readable, underlying code.

== How to Access the Wizard ==

# Open your '''Domoticz dashboard''' and navigate to <code>Setup</code> → <code>More Options</code> → <code>Events</code>.
# Click the '''+ button''' to create a new script.
# Select '''dzVents''' and launch the '''Automation Wizard'''.

[[File:Dzventsautomationwizard.png]]

== How it Works (UI Steps) ==

* '''Trigger Selection:''' Define what activates the script (e.g., a specific device turning On, a security panel state change, or a time schedule).
* '''Configuration:''' Establish exactly which device or condition to evaluate.
* '''Action Setup:''' Determine the outcome (e.g., toggle another light, send a notification).
* '''Review & Output:''' The wizard dynamically generates the proper <code>dzVents</code> syntax, minimizing potential syntax errors.

== Typical Use Cases ==

* Linking a motion detector to a smart plug while factoring in room temperature or lux constraints.
* Setting up automatic sunset and sunrise schedules.
* Sending automated alerts if a door sensor changes state

File:Dzventsautomationwizard.png

2026-07-10T07:14:43Z

Walter vl:

Dzvents automation wizard

Matter

2026-07-07T07:52:22Z

Walter vl:

This page is WIP!

From beta 2026.1 domoticz has a Matter integration based on matter.js server (https://github.com/matter-js/matterjs-server)

'''Note:''' Thread and Matter rely heavily on IPv6, so make sure your network and Domoticz device can communicate on IPv6

=== Matter.js server ===
For the matter integration to work you need a running matter-js-server (setup with docker: https://github.com/matter-js/matterjs-server/blob/main/docs/docker.md)

docker-compose.yml example<syntaxhighlight lang="yaml">
services:
matterjs-server:
container_name: matterjs-server
image: ghcr.io/matter-js/matterjs-server:latest
read_only: true
network_mode: host
restart: unless-stopped
volumes:
- ./data:/data
</syntaxhighlight>Navigate to the docker compose directory (as example) where the matter.js docker-compose.yml file is created.

<code>cd docker/matterjs-server</code>

Start the server

<code>docker compose up -d</code>

View logs

<code>docker compose logs -f</code>

Stop the server

<code>docker compose down</code>

When running with default options the UI should be available on port 5580 of the server eg http://192.168.1.123:5580

=== Thread Border router ===
If you want to use the wireless standard thread, that is needed for e.g. the new Ikea devices, you need a Thread-border-router.

There are many thread border routers available.

The commercial ones:

* Apple TV
* Apple Homepod
* Google Nest Hub
* Amazon Echo dot
* Ikea dirigera (newest version)
* etc

Then there the open source ones:

* Openthread border router (ESP) https://openthread.io/guides/border-router/espressif-esp32
* Home Assistant ZBT-2

=== Domoticz hardware gateway install ===
When matter.js is running you can add in Domoticz the Matter Hardware gateway and fill in the IP and port of your matter.js server eg 192.168.1.123:5580

=== Using Matter with Domoticz ===
Devices paired to the matter server are also being added to Domoticz and can be controlled from Domoticz User interface.

There is a setup button next to the Matter hardware in Domoticz that you can use, and you can also use the native web interface of the matterjs-server docker container (eg http://192.168.1.123:5580)

=== Discussion: ===
See forum thread https://forum.domoticz.com/viewtopic.php?t=41424

Plugins

2026-07-03T08:46:33Z

Walter vl: /* Python Plugins List */ PypluginStore

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|PyPluginStore
|modern plugin manager for Domoticz
|[https://forum.domoticz.com/viewtopic.php?t=44626 link]
|https://github.com/adrighem/PyPluginStore
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus, to control 1 or more single-phase energy meters
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|DTS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus, to control 1 or more three-phase energy meters
|
|https://github.com/CreasolTech/domoticz-dts238
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti EQ2021 EQ3021 boilers
|Emmeti hot water heat pump
|
|https://github.com/CreasolTech/domoticz-emmeti-eq2021
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|Garbage Calender NL
|garbage/waste collection schedule
|[https://forum.domoticz.com/viewtopic.php?t=44560 link]
|https://github.com/MadPatrick/domoticz_garbage
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|HP iLo monitor
|HP server monitor
|[https://forum.domoticz.com/viewtopic.php?t=44638 link]
|https://github.com/MadPatrick/domoticz_HP_ilo
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|KPN experia v10
|KPN Experia Box V10 Device Presence Tracker and control
|[https://forum.domoticz.com/viewtopic.php?t=44623 link]
|https://github.com/adrighem/domoticz-kpn-experia-v10
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|WiFiTic Teleinfo
|Cartelectronic WiFiTic module
|[https://forum.domoticz.com/viewtopic.php?t=44704 link]
|https://github.com/DebugBill/domoticz-wifitic
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Managing Devices

2026-06-28T20:45:04Z

Walter vl: /* Edit Notifications */

==Introduction==
Devices are created when the [[Hardware Setup|Hardware gateway]] (Setup - Hardware) to were the devices are connected to is added to Domoticz.

[[Hardware Setup|D]]<nowiki/>evices can be managed in the [[Setup Devices|Devices lis]]<nowiki/>t (menu Setup - Devices) or in the overview screens Switches, Scenes, Temperature, Weather and Utility. It depends on the type of device where they are placed.

For each type of device there is a tab in the top bar navigation. The tabs can be switched on/off in the menu [[Application Settings|Setup - Settings]]. It is not possible to move devices from one tab to the other.

Basic steps to add devices:

#Go to Setup - [[Application Settings|Settings]] to set your location (important for day/night timing).
#Go to Setup - [[Hardware Setup|Hardware]] and add an hardware gateway. Follow the instructions for that particular hardware gateway.
#Go to Setup - [[Setup Devices|Devices]] to enable (if disabled) the devices created by the hardware gateway

==Device Widgets==
Each hardware device can be represented by one (ore more) device widgets. For example a smart thermostat can have a Temp Setpoint widget, a Set Mode widget, a Temp Sensor widget etc

As they have different functions they could show up in different Device Tabs (Switches, Temperature, Weather, Utility) in Domoticz.

If the device is battery controlled and the battery level is low, the highlight color will be Yellow (see also [[Application Settings#Battery Low Level|wiki page for settings]])

If the devices is not seen for a long time (timed out) the highlight color will be Red. (See also [[Application Settings#Battery Low Level|wiki page for settings]])

Some basic actions you can do with device widgets:

*Adding some devices as your '[[Managing Devices#Dashboard|favorites]]' by clicking on the yellow star on the device Widget. These devices will show up on your [[Managing Devices#Dashboard|dashboard]], to give you easy access.
*Setup [[Managing Devices#Edit Notifications|notifications]] when for example sensors are going to a predefined level (eg temp < 0 degrees)
*Setup [[Managing Devices#Edit Device Timers|Timers]] to switch devices on or off in a time schedule ([[Timer Plan]])
*Adding a [[Floorplans|floorplan]]. If you want you can create a floorplan, and place buttons on there for all your devices. You can even set this as your dashboard if you want.
*Show [[Managing Devices#Show Device Log|Device Log files]] or graphs per day/month/year. Generate yearly reports for further analysis

==Switches==
Switches are devices that can switch from one state to the other (on/off/level etc) and are displayed in widgets. The lights/switches tab includes devices like:

*Light Switches
*Door sensors
*Blinds (see special page for [[Blinds]])
*Doorbells
*Security
*Sirens

[[File:Switches screen.png|none|frame]]
Each item has the following options:

- Status icon that can be push to toggle on/off status (depending on the hardware)

- Favorite push icon (to display this device on the Dashboard tab)

- [[Managing Devices#Show Device Log|#Log]] (Displays the log)

- [[Managing Devices#Edit Device|#Edit]] (Edit device parameters, and Sub/Slave Devices)

- [[Managing Devices#Edit Device Timers|#Timers]] (For setting up a schedule per device)

- [[Managing Devices#Edit Notifications|#Notifications]] (see Notification chapter)

By Dragging/Dropping the sensor items, you can change the position of the devices in the window.

Lights and Switches can be added by:

- Auto Learning

- Manual Setup

- Activating them through the [[Setup Devices|Setup - Devices page]]

 

===Adding a RF Light/Switch by Auto Learning===
Prerequisite: Have setting "[[Application Settings#Hardware.2FDevice|Accept new hardware devices]]" enabled (enabled by default)

By pressing the ‘Learn Light/Switch’ button you have 5 seconds to press the remote/switch/sensor.

Note: Be sure you have no other Domoticz switches/Lights (eg Zwave, Zigbee, plugin controlled etc) are triggered during these 5 seconds. Else you get an error message that device is already known.

[[File:Add Switches buttons.png]]

If this time is too short you should position yourself nearer the remote/switch/sensor by using a portable computer such as Tablet or Smartphone

Once you press the button the following screen is presented:

[[File:Add RF Switch light.png]]

===Adding a RF Light/Switch Manually ===
If you know the switch brand/type/address it is also possible to enter the parameters by hand.

It is also possible to create a new [[Dummy for virtual Switches|‘virtual’ device]] that can control a light without having to buy a remote/switch.

[[File:Add Switch light manually.png]]

===Sub/Slave devices===
Used for RFLink/RfXCom devices to synchronise on/off statuses in Domoticz as these RF devices don't send status feedback.

Note: To use a switch to switch multiple lights on/off use the Domoticz [[Managing Devices#Scenes .28also for Groups.29|Group (or scene)]] functionality.

To set a Master for a particular switch/light, click on the Edit button of the Sub/Slave device, Select the Master device from the pull down list and click on Add.

See below for more usage examples.

[[File:Sub slave Master.png]]

Most Lights can be controlled from up to 6 remotes.

See the following two examples:

====Example 1 (Outdoor Light) ====
Imagine you have an outdoor light that is controlled by a switch (*a) from inside the house.

It is possible to buy small remote controllers (*b) for on a keychain.

When you also want to control the outside light from this small remote, the small remote (*b) is a Sub/Slave device from the main switch (*a).

====Example 2 (Floor Lights) ====
Imagine you have a house with two floors, each floor has its own switch (*a, first floor) and (*b, second floor).

Downstairs next to your exit door you have a switch (*c) to turn ON / OFF ALL the lights. In this case the

switch (*c) is a Sub/Slave device for switch (*a, first floor) and (*b, second floor)

Consult your hardware manual on how to setup two/multiple switches for one light.

<nowiki>*</nowiki>Note: When adding a Sub/Slave device, this will not be visible in the ‘Lights’ tab by default. You see this device in the ‘Edit’ screen from the device you added it too.

If you also want to control or see the Sub/Slave device, you will have to add this device again, and set it up as Main device.

==Scenes (also for Groups)==
In the tab Scenes you can manually add Scenes and Groups to switch multiple devices in one time.

[[File:Group and Scene widget.png]]

What is the difference between Scenes and Groups:

*A "Group" is a set you can turn on or off together. Like a big extension cord with a power switch. They all go on or off. But every device can switch on with different characteristics like dim level, color etc.
*A "Scene" is a predefined setup of lights and devices. So you can setup 1 light to be on, another to off. Have the ledstrip/milight set to a nice blue color, close your curtains, switch on your radio on station Xyz. That's also why you can't switch a scene off, but only to on. You will have to make an extra scene (or group) to switch the devices off.

So for example a group is used to turn all lights off when you leave the house.

And a scene is used when you have a nice setup of lightning you want when you are going to watch a movie.

'''States'''

*On: All related devices are On.
*Off: All related devices are Off.
*Mixed: Related devices have a mixed On/Off state

'''Add a Group/Scene'''

To Add a Group or Scene click on the Add Scene button, type a name and decide if you want to make a group or scene. Click on Add Scene to finally create it.

[[File:Add Group or Scene.png]]

 

===Edit Group Scene===
Click on Edit button of the group scene to add devices to the group scene and change the characteristics (dim level, color, on/off/toggle etc) when switching on.

The Off delay on switch device in a Group/Scene causes a device to switch Off with a delay of the set amount of seconds after the switchOff command is given.

This differs from the [[Managing Devices#On Off Delay|Off delay on a normal switch]]

Click on the timer button to set timers for the Scene or group. See the [[Managing Devices#Edit Device Timers|general timer instruction]].

Activation Device: You can use a Domoticz Switch to trigger the Group or Scene.

* Use the '''Add Device''' button to add a device by using it (eg remote or zigbee switch).
* Use the '''Add Manual Light/Switch Device''' button the select a switch/light from the list of Domoticz devices.

Devices: Add or remove devices that should be part of the Group or Scene. You can also set the state of the selected device.

[[File:Edit Group or Scene.png]] 

==Temperature==
The temperature tab includes all sensors that have a temperature sensor.

[[File:Afbeelding 12.png]]

A temperature sensor can also include a Humidity sensor.

Each item has the following options:

- Favorite push icon (to display this device on the Dashboard tab)

- [[Managing Devices#Show Device Log|#Log]] (Displays the Device log or Graph)

- [[Managing Devices#Edit Device|#Edit]] (Edit device parameters)

- [[Managing Devices#Edit Notifications|#Notifications]] (see Notification page)

By Dragging/Dropping the sensor items, you can change the position of the devices in the window.

===Custom Graph===
Most devices have a Report button. In the Temperature tab the is a Custom Graph reporting button where you can set out various sensor values in one graph.

For example the inside and outside temperature of last week.

[[File:Custom graph2.png]]

==Weather==
The weather tab includes all sensors that are related to weather

[[File:Afbeelding 11.png]]

A weather sensor can be

- Rain Meter

- Wind Meter

- UV Meter

- Barometer

Each item has the following options:

- Favorite push icon (to display this device on the Dashboard tab)

- [[Managing Devices#Show Device Log|#Log]] (Displays the Device log or Graph)

- [[Managing Devices#Edit Device|#Edit]] (Edit device parameters)

- [[Managing Devices#Edit Notifications|#Notifications]] (see Notification page)

- Forecast (shows the weather forecast when [[Weather forecast from forecast.io in Domoticz|Darksky weather forecast site is added]])

By Dragging/Dropping the sensor items, you can change the position of the devices in the window.
 

==Utility==
The utility tab includes meter sensors (Energy / Gas / P1 / YouLess / Voltage / AD / Air Quality / …), percentage, text and lux sensors and thermostats (for setting setpoints)

[[File:Utility tab.png]]

Each item has the following options:

- Favorite push icon (to display this device on the Dashboard tab)

- [[#Log]] (Displays the log)

- [[#Edit]] (Edit device parameters)

- [[Managing Devices#Edit Device Timers|#Timers]] (For setting up a time schedule for thermostat setpoints)

- [[Managing Devices#Edit Notifications|#Notifications]] (see Notification chapter)

By Dragging/Dropping the sensor items, you can change the position of the devices in the window.

===Labels Compact/Mobile mode===
When using the dashboard in compact or mobile mode, there is limited room for the current status.

Therefor the following labels apply:

*R = Return
*T = Today
*U = Usage
*A = Actual

==Dashboard==
In the Dashboard all the devices are listed that you have flagged as favorite with the favorite toggle switch (star) on each device widget. They will be ordered on the dashboard in the same ways as on the tabs.

If you want to display a device only on the dashboard and not on the device tabs/pages you can [[Managing Devices#Make Hidden|make it hidden]].

[[File:Dashboard Dz.png]]

==Floorplan==
With [[Floorplans]] you can create a graphical interface of your home and rooms. When clicking on a room you will be zoomed in to view the room in more detail.

Switches can be activated directly from the floorplan. See the page [[Floorplans]] for more instructions.

If you want to display a device only on the floorplan and not on the device tabs/pages you can [[Managing Devices#Make Hidden|make it hidden]].

[[File:Floorplan machinon.png]] 
 
==Show Device Log==
By pressing the log button you can see the log of the sensor. If the device logs numeric values they will be displayed as a graph per day/month/year. If the sensor logs text you will get a table of values.

For switches also the origin of the changed value will be displayed (script/user).

It is possible to '''zoom in/out''' by selecting a range. On mobile devices use double finger moves.

For temperatures and some other dataranges it is also possible to see the '''past month/year data''' next to the last month/year data. So you can visualize the difference. It is also possible to show a '''Trendline''' wich indicates the trend of the sensor value.

For some utility devices (eg Electricity, Gas, Water etc) a '''Comparison''' graph over the years is displayed

By pressing the '''BACK''' button you return to the overview.

By pressing on ([[Managing Devices#Custom Graph|Custom]]) '''Report''' you can go to the Report function. Here you see yearly and monthly reports and can you export them to excel.xls, .csv and image files for further processing.

 [[File:Domoticz logging.png]]

[[File:Comparison log.png]]

===Custom Graph===
In the Temperature tab the is a Custom Graph reporting button where you can set out various sensor values in one graph.

For example the inside and outside temperature of last week.

[[File:Custom graph2.png]]

===Device Report===
Most sensor devices have a Report button on the LOG page (see previous section). With the report you can go back in your history. It is also possible to export the data as images, CSV or Excel files.

The up/down arrows in the last column indicate a increase or decrease value compared with the month or day earlier.

When click on the blue Arrow in the month column you get a detailed value report per day of that month.

For Temperature devices also the lowest and highest value are listed. For a year also the [https://en.wikipedia.org/wiki/Heating_degree_day degree days] is listed so you can compare your energy consumption for heating based on true values.

For energy devices a yearly summary is listed. The earning or costs are calculated by the tariffs set in the page [[Application Settings#Meter.2FCounters Setup|Setup-Setting- Meters Counters]]. Also Day/night tarifs and delivery and return (eg from solar panels) are supported for P1 Smart Meter devices.

''Example Reports Energy devices'' 
[[File:P1-report.png]]

[[File:Device report.png]]

''Example reports Temperature device''

[[File:Report Temperature device.png]]
===Remove incorrect value from database===
It is possible to remove (or delete) an incorrect sensor value (record) from the database by <code>shift+left mouse click</code> on the value in one of the graphs on the device log page. You will get a popup dialog to approve the removal.

On a tablet/smartphone without mouse: Select the to be deleted/removed value by clicking on it and thereafter click the pancake menu in right top corner. Then the acknowledgement popup will be shown.

NOTE: This function is not working on the report page so it is not possible to remove data with this function older than 1 year.

[[File:Remove value.png]] 

===Exporting graph data===
By clicking on the right top hamburger icon in a graph you can select the export data method of that graph

Options are to export into an image/document file (PNG, JPEG, PDF, SVG) or download the values as an CSV or Excel file.

If you want to export a specific time span use a [[Domoticz API/JSON URL's#History|Domoticz History API call]].

[[File:Export graph data.png]]

 

==Edit Device==
In this dialog you can rename the device, change the switch type, remove, or replace it.

===Switches===
Blinds: See special page for [[Blinds]]

Also you can add delays, extra actions by [[Scripting in Domoticz|scripts]] or [[Domoticz API/JSON URL's|http API json commands]], protect it for unauthorised usage etc.

[[File:Edit Switches.png]]

====Make Hidden====
If you add a dollar ($) sign infront of the name (eg $device_name) the device becomes hidden (but active). It will disappear from the Sensor/Switches tabs. It still will be visible on the [[Setup Devices|device list]] and can be used in the [[Floorplans|floorplan]] (room $Hidden Devices).

Also when you have made the device favorite before renaming the device stays visible on the dashboard.

====Change Switch Type====
In the edit dialog you can modify the type of switch. The other attributes depends on the type of switch.

For a full list and short description see wiki page [[Dummy_for_virtual_Switches#Switches]]

[[File:Switch-Types.png]]

====Change Icon====
Here you can Change the Icon for the device. It is possible to use your own [[Custom icons for webinterface|custom icons]]

====On Off Delay====
The On delay causes a device to switch On with a delay of the set amount of seconds after the switchOn command is given.

The Off delay on switch device causes a device to switch Off with a delay of the set amount of seconds after the device switched to On.

The Off delay on switch device in a Group/Scene causes a device to switch Off with a delay of the set amount of seconds after the switchOff command is given.

====On Off Action====
Here you can refer to [[scripts]] or [[Domoticz API/JSON URL's|Domoticz API/JSON URL]] to trigger other actions inside or outside Domoticz.

Also possible to use http/https URL's when the device can be switched in this way (eg ESPEasy, Tasmota, etc)

[[File:2015-08-21 12 26 41-Domoticz.png|679x679px]]

====Protected====
Enable (default Disabled) extra protection for switching of this device. This will give a popup when trying to switch the device.

The Switch/Light protection password is managed by setting [[Application Settings#Light.2FSwitch%20Protection|Light/Switch Protection]]

 

===Sensors===
Sensor have less options to edit:

====Make Hidden====
If you add a dollar ($) sign infront of the name (eg $device_name) the device becomes hidden (but active). It will disappear from the Sensor/Switches tabs. It still will be visible on the [[Setup Devices|device list]] and can be used in the [[Floorplans|floorplan]] (room $Hidden Devices).

Also when you have made the device favorite before renaming the device stays visible on the dashboard.

====Change Icon====
Here you can Change the Icon for the device. It is possible to use your own [[Custom icons for webinterface|custom icons]]

====Multiplier/Adjustment====
Some Sensors like temperature have Adjustment or Multiplier field to calibrate the measured value with the real, to be displayed value.

[[File:Edit Temp Sensor.png]]
 
===Delete===
To delete the device from the database click on the DELETE button. After confirmation the device and its stored values will be deleted.

===Replace device===
Some devices change their unique ID when a new battery is installed and will get a new idx ID in Domoticz. Also when migration from one hardware gateway to another (eg OpenZwave to Zwave-JS-UI) you could need to replace devices.

To move the old sensor data (history logging) to the new device act as follow:

*First, add (or is added by new gateway) the new device to the system, and call it for example ‘New UV Meter’.
*Next press the Edit button on the Old device, select replace and select the new Device. (In this case the devices called ‘New UV Meter’).
*Next press OK. Result:
**The old and new device will be merged and get the name and IDX of the '''old device'''. This will prevent changes in scripts that use this device.
**The new device will be deleted. (behavior since Stable 2022.1)
**If there is a hardware gateway difference between Old and New device (eg when switching from OZW to Zwave JS UI MQTT) the merged device (with old name and idx) will get the hardware gateway of the new device.

 
==Edit Device Timers==
Each switch, group, scene or thermostat device can be activated by timers to change the status or for thermostats the setpoint temperature.

There can be more timers per switch/thermostat so you can make a complete schedule.

They also make part of a [[Timer Plan|timer plan]] so you can set up for example a holiday schedule for your lights.

The timer options are partly dependent of the switch type and Timer type.

To '''add''' a timer to the device fill in the setting parameters and click on button ''Add''.

To '''modify''' an existing timer select the timer, modify the settings and click on button ''Update''.

To '''copy''' a timer, select an existing timer, modify the settings and click on button ''Add''.

To '''delete''' a timer, select an existing timer and click on button ''Delete''.

===Standard Settings===

*Enable/Disable.
*Type: Trigger type for timers, Can be based on specific time, per day, month, year or based on delta against Sunrise or Sunset (which are calculated based on your location in Settings). See the list of timers types below the image.
*Time: The absolute time in hh:min to change status or setpoint of the device. Can also be a delta against before/after Sunrise/Sunset timer types, eg 1:30 hours before sunset
*Randomness: Add a randomness to the activation time. The Random timer delta can be set in the [[Application Settings#Random Timer|settings menu]]. Could be useful to switch lamps on/off more randomly on holiday timing schedules.
*Persistent: Will be available in all [[Timer Plan|timer plans]] when enabled. (available from beta dd 20-12-2023)
*Command: The command for setting the device status. On or Off

'''Note''': It will take several minutes after saving that the timer entries become active. So for testing purposes take a minimum of 2 minutes delta from current time.

'''Note''': Domoticz calculates some events like Sunset and Sunrise, Twilight etc based on your location, so be sure you have set the location correctly in menu '''Setup -> Settings'''

===Optional Settings===

*Level:
**In case of a dimmer type you can set the dimlevel.
**In case of a selector switch the selector level
*Color: In case of a color RGB lamp you can set the color.
*Value: In case of a Thermostat this is the setpoint value.
*When and Days: (depends on Timer type). Short select the the days of the week the timers settings should be valid. Alternativly you can select the active days manually.
*Date: (depends on Timer type). Select a date from the popup calendar or type a date in yyyy-mm-dd format.

*

[[File:Edit Timers.png|none|frame]]

==='''Timer types:'''===

*0: Before Sunrise
*1: After Sunrise
*2: On Time
*3: Before Sunset
*4: After Sunset
*5: Fixed Date/Time
*6: Odd Day Numbers
*7: Even Day Numbers
*8: Odd Week Numbers
*9: Even Week Numbers
*10: Monthly
*11: Monthly (Weekday)
*12: Yearly
*13: Yearly (Weekday)
*14: Before Sun at South
*15: After Sun at South
*16: Before Civil Twilight Start
*17: After Civil Twilight Start
*18: Before Civil Twilight End
*19: After Civil Twilight End
*20: Before Nautical Twilight Start
*21: After Nautical Twilight Start
*22: Before Nautical Twilight End
*23: After Nautical Twilight End
*24: Before Astronomical Twilight Start
*25: After Astronomical Twilight Start
*26: Before Astronomical Twilight End
*27: After Astronomical Twilight End

For an explanation of Civil, Nautical and Astronomical Twilight check the wikipedia page: https://en.wikipedia.org/wiki/Twilight

===Weekly timer editor===
From version 2023.1 it is now possible to switch from table to grid view for easy creating an managing weekly timer schedules.

Click on the Grid tab to enable the week overview.

[[File:Timers-weekly-editor.png]]

==Edit Notifications==
Each device has different notifications (depending on the hardware options).
[[File:Edit Notifications.png|none|frame]]

For example, in the above screenshot, you want to be notified if the temperature rises above 45 degrees.

'''Switches'''

Type: Can notify on Type <code>Switch On</code> or <code>Switch Off</code> state.

Level: For selector switches and dimmers a level condition can be added.

Custom Message: An optional custom message can be added. You can use parameters $value and $name in this custom message.

Action: Optional a script can be added to run on notification trigger. For example to run a TextToSpeak notification.

'''Sensors'''

Can notify on Type:

*Value (Usage, Temperature, Today etc): When the measured value meets the conditions you entered (eg temperature rises above 45 degrees).
*Last Update: When the last update time was according your conditions (eg Last update time was larger dan 60 minutes away).

[[File:NotificationWithScript.jpg]]

Also settings for

*Priority (of notification),
*Ignore default interval of [[Application Settings|settings page]] (enable/disable)
*Action: Optional a script can be added to run on notification trigger. For example to run a TextToSpeak notification.
*Recovery Notification (enable/disable when the sensor conditions have been recovered). This check box is only available for devices in Temperature, Weather and Utility tab. Not available for switches/light devices.
*

To '''add''' a notification to the device fill in the setting parameters and click on button ''Add''.

To '''modify''' an existing notification select the notification, modify the settings and click on button ''Update''.

To '''copy''' a notification, select an existing notification, modify the settings and click on button ''Add''.

To '''delete''' a notification, select an existing notification and click on button ''Delete''.

'''Notification systems'''

The following [[Notifications|notification]] services are supported:

*Prowl (iPhone/iPad)
*NMA (Android)
*PushBullet
*Pushsafer (iOS/Android/Windows10/Chrome/Firefox) + Image
*Pushover (Android/iOs)
*Pushalot (Windows/Windows Phone)
*Clickatell SMS
*Custom HTTP/Action
*Kodi Media Player
*Logitech Media Server
*Google Cloud Messaging
*Telegram

See also the [[Application Settings#Notifications|Applications Settings section Notification]] and the [[Notifications]] page for the various notification methods.

 
[[Category:Domoticz]]
[[Category:Manual]]

Domoticz API/JSON URL's

2026-06-26T06:47:12Z

Walter vl: /* Counter Incremental */

Domoticz allows you to interact with all your switches and sensors using JSON, either interactively through a browser or programmatically from a scripting language. In fact, when you interact with the Domoticz UI through your browser by clicking on buttons and such, under the hood it's JSON that actually communicates your changes back to the Domoticz engine (Hint: You can watch this behaviour at any time by enabling '''developer tools''' in your browser and watching the ''network'' tab's traffic when you change something through the UI. See the section on ''changing a zwave device parameter'' for an example, with screenshot). This wiki describes how to use this versatile API. 

==Warning Stable 2023.2 (and newer)==
For users using API calls from outside Domoticz there has been some changes in API calls. They now always should be of the form <code>/json.htm?type=command&param=**command**</code>

For example

<code>/json.htm?type=graph</code> will be <code>/json.htm?type=command&param=graph</code>

<code>/json.htm?type=devices</code> will be <code>/json.htm?type=command&param=getdevices</code>

More info in Forum topic https://forum.domoticz.com/viewtopic.php?p=303581#p303581

<s>The following old RType commands will keep working but will give a deprecation warning eg</s>

<code><s>[WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command! (IP nnn.nnn.nnn.nnn)</s></code>

'''''Warning: in Domoticz stable 2025.1 these old RType API calls are really removed and instead of a warning you will get an error (404 - not found)!!'''''

'''/json.htm?type=**old command** -> /json.htm?type=command&param=**new command**'''
*"settings" -> "getsettings"
*"users" -> "getusers";
*"devices" -> "getdevices"
*"hardware" -> "gethardware";
*<s>"events" -> "events"</s>
*"notifications" -> "getnotifications"
*"createdevice" -> "createdevice"
*"scenes" -> "getscenes";
*"plans" -> "getplans"
*"graph" -> "graph"
*"scenelog" -> "getscenelog"
*"mobiles" -> "getmobiles"
*"cameras"-> "getcameras"
*"cameras_user" -> "getcameras_user"
*"schedules" -> "getschedules"
*"timers" -> "gettimers"
*"scenetimers" -> "getscenetimers"
*"setpointtimers" -> "getsetpointtimers"
*"plans" -> "getplans"
*"floorplans" -> "getfloorplans"
*"lightlog" -> "getlightlog"
*"textlog" -> "gettextlog"
*"setused" -> "setused"

The following old RType command has no fallback:

*"/json.htm?type=events"

The updated syntax is "''/json.htm?type=command&param=events&'''evparam=<eventsparam>'''''"

=Format=

<nowiki>http://<username:password@>domoticz-ip<:port>/json.htm?api-call</nowiki>

*<username:password@> = the username and password to access Domoticz, this is optional, see the [[Security]] page for details setting up login.
*domoticz-ip = the IP-address or hostname of your Domoticz installation.
*<:port> = the port number of your Domoticz installation, this is optional.

eg. http://192.168.1.2:8080/json.htm?type=command&param=udevice&idx=$idx&nvalue=0&svalue=79

Hint: You can have a look at the database for the nValue/sValue, or the .cpp code. 
==Making output more readable==
By default, most browser will display the JSON-output in a unordered mess, but some (like FireFox) will recognize it is JSON and show it in a readable manner. To make it more readable you could use a browser plugin that formats the JSON to a more human-readable layout. 
For Google Chrome you could use [https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc JSONView (Chrome web store)]. For other browsers a similar extension will probably exist. Look in the extensions/add-on store of your browser.

There are online sites which helps to do the same like https://jsonformatter.org. This site helps to format, tree view and validate JSON.

==Authorization==
When using some method other than a browser to connect to Domoticz it may be necessary to do Authorization differently.
Authorization over HTTP is done by setting the "Authorization" HTTP request header when sending the request to Domoticz. The value of this header is a base64 encoded string of the username and password. When connecting to Domoticz using a browser and the URL method above the browser sets the appropriate header. When creating your own app or script this is not always done for you.

*First the username and password are combined into one string "username:password"
*This string is encoded using the RFC2045-MIME version of base64
*The authorization method and a space i.e. "Basic " is then put before the encoded string.

This results in a header in the following format:
<source lang="json">Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</source>

How the header is send differs per programming language. Check the documentation of the language of your choice on how to set http request headers.

==Users==
When you use an user and password in this api, the user must have "user" or "admin" rights. See also page [[User Management]] 
The user also must have the right to access the device (see 'Set Devices' in Edit Users page).

==Base64 encode==
To encode a string using base64 you could use : [https://codebeautify.org/base64-encode codebeautify.org/base64-encode]

==Response==
All responses include a status which is either '''OK''' on success or '''ERR''' on failure
<source lang="json">{
"status" : "OK"
}</source>

=General usage=

Please note that many characters are not permitted in URL strings, including spaces, brackets, etc. Depending on which options below you are using, it may be necessary to '''URL encode''' the string first. This is also called URI-encoding, escaping or percent-encoding. See [https://www.url-encode-decode.com URL encode/decode].

As an example, the string:

This is a test ! (Really)

when properly encoded, looks like this

This%20is%20a%20test%20%21%20%28Really%29

It's also allowable to use a '+' instead of '%20' to encode spaces (this is normally reserved for HTML forms processing but Domoticz accepts both).

==A note on IDXes==
There are different categories of IDX values, such as for devices, for scenes, for timers, for hardware devices, etc. Make sure that you are using the correct IDX value when trying the commands below. Device IDXes can be found by looking at the ''Setup --> Devices'' tab in the UI. Similarly, ''Setup --> Hardware'' will list the hardware category IDXes. See the section(s) on ''scenes'' and ''timers/schedules'' below to see how to retrieve their particular IDXes or timerIDs using JSON.

==Retrieve status of Domoticz instance==

You can get the status of a Domoticz instance with:

/json.htm?type=command&param=getversion
<source lang="json">{
"DomoticzUpdateURL": "http://www.domoticz.com/download.php?channel=beta&type=release&system=linux&machine=armv7l",
"HaveUpdate": false,
"Revision": 9540,
"SystemName": "linux",
"UseUpdate": true,
"build_time": "2018-05-29 14:27:24",
"dzvents_version": "2.4.6",
"hash": "30295913",
"python_version": "3.5.3 (default, Jan 19 2017, 14:11:04) \n[GCC 6.3.0 20170124]",
"status": "OK",
"title": "GetVersion",
"version": "3.9530"
}</source>

'''From Stable 2023.2''' (7-jun-2023) when a request is done without any authorisation, only the following is returned:
<code>{
"status" : "OK",
"title" : "GetVersion"
}</code>
When requested by a (non-admin) User, it gives (''which is the current default response for users''):
<code>{
"HaveUpdate" : false,
"UseUpdate" : false,
"build_time" : "2023-06-04 16:08:09",
"dzvents_version" : "3.1.8",
"hash" : "98a7d1eef-modified",
<nowiki> "python_version" : "3.8.10 (default, Nov 14 2022, 12:59:47) \n[GCC 9.4.0]",</nowiki>
"status" : "OK",
"title" : "GetVersion",
"version" : "2023.1 (build 15331)"
}</code>
And for admins
<code>{
"DomoticzUpdateURL" : "<nowiki>https://www.domoticz.com/download.php?channel=stable&type=release&system=linux&machine=x86_64</nowiki>",
"HaveUpdate" : false,
"Revision" : 15091,
"SystemName" : "linux",
"UseUpdate" : true,
"build_time" : "2023-06-04 16:08:09",
"dzvents_version" : "3.1.8",
"hash" : "98a7d1eef-modified",
<nowiki> "python_version" : "3.8.10 (default, Nov 14 2022, 12:59:47) \n[GCC 9.4.0]",</nowiki>
"status" : "OK",
"title" : "GetVersion",
"version" : "2023.1 (build 15331)"
}</code>
 
==Get list of all defined users in the system==

<code>/json.htm?type=command&param=getusers</code>

<source lang="json">{
"result": [
{
"Enabled": "true",
"Password": "abcdef1234567890abcdef1234567889",
"RemoteSharing": 1,
"Rights": 2,
"TabsEnabled": 127,
"Username": "waaren",
"idx": "2"
},
{
"Enabled": "true",
"Password": "abcdef1234567890abcdef1234567889",
"RemoteSharing": 0,
"Rights": 2,
"TabsEnabled": 0,
"Username": "IFTTTx",
"idx": "3"
},
],
"status": "OK",
"title": "Users"
}</source>

==Get settings==

<code>/json.htm?type=command&param=getsettings</code>

This will return the settings defined in "Setup" under a JSON form.
For ex. :
<source lang="json">{
"AcceptNewHardware" : 0,
"ActiveTimerPlan" : 0,
"ClickatellEnabled" : "",
"ClickatellFrom" : "",
"ClickatellPassword" : "",
...
}</source>

==Retrieve Domoticz logfile information==

You can get the last couple (fixed at max. 100) of logmessages with:

/json.htm?type=command&param=getlog&lastlogtime=LASTLOGTIME&loglevel=LOGLEVEL

*

LOGLEVEL 1 = normal
2 = status
4 = error
268435455 = all

LASTLOGTIME starting with logmessages in LASTLOGTIME seconds since last epoch ( 0 = all available)

<source lang="json">{
"LastLogTime": "1615579727",
"result": [
{
"level": 4,
"message": "2021-03-12 17:11:47.613 Error: BuienRadar: Problem Connecting to Buienradar! (Check your Internet Connection!)"
},
{
"level": 4,
"message": "2021-03-12 18:30:05.598 Error: dzVents: Error: (3.1.6) openUV: /opt/domoticz/scripts/dzVents/scripts/openUV.lua:63: attempt to index a nil value (field 'result')"
},
{
"level": 4,
"message": "2021-03-12 21:08:47.542 Error: (Evohome) status request failed with message: Timeout was reached"
}
],
"status": "OK",
"title": "GetLog"
}</source>

==Add a log message to the Domoticz log==

You can add a log message to the system with:

/json.htm?type=command&param=addlogmessage&message=MESSAGE&level=LEVEL

*MESSAGE = a string you want to log. Make sure to URL-encode any unsafe non-alphanumeric characters. See [https://www.url-encode-decode.com URL encode/decode]

"LEVEL" 1 = normal // default
2 = status
4 = error

<source lang="json">{
"status": "OK",
"title": "AddLogMessage"
}</source>

==Retrieve status of specific device==

You can get the status of a device with:

/json.htm?type=command&param=getdevices&rid=IDX

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*or IDX = 10,20,30 (for querying a range devices, in this case devices with IDX 10, 20 and 30)

<source lang="json">{
"ActTime": 1613058183,
"AstrTwilightEnd": "19:39",
"AstrTwilightStart": "06:06",
"CivTwilightEnd": "18:20",
"CivTwilightStart": "07:24",
"DayLength": "09:46",
"NautTwilightEnd": "19:00",
"NautTwilightStart": "06:45",
"ServerTime": "2021-02-11 16:43:03",
"SunAtSouth": "12:52",
"Sunrise": "08:00",
"Sunset": "17:45",
"app_version": "2020.2 (build 12936)",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
"AddjValue2": 0,
"BatteryLevel": 255,
"CustomImage": 0,
"Data": "On",
"Description": "Plain text",
"DimmerType": "none",
"Favorite": 0,
"HardwareDisabled": false,
"HardwareID": 3,
"HardwareName": "virtual",
"HardwareType": "Dummy (Does nothing, use for virtual switches only)",
"HardwareTypeVal": 15,
"HaveDimmer": true,
"HaveGroupCmd": true,
"HaveTimeout": false,
"ID": "00014052",
"Image": "Light",
"IsSubDevice": false,
"LastUpdate": "2021-02-10 22:47:03",
"Level": 0,
"LevelInt": 0,
"MaxDimLevel": 100,
"Name": "mySwitch",
"Notifications": "false",
"PlanID": "0",
"PlanIDs": [
0
],
"Protected": false,
"ShowNotifications": true,
"SignalLevel": "-",
"Status": "On",
"StrParam1": "",
"StrParam2": "",
"SubType": "Switch",
"SwitchType": "On/Off",
"SwitchTypeVal": 0,
"Timers": "false",
"Type": "Light/Switch",
"TypeImg": "lightbulb",
"Unit": 1,
"Used": 1,
"UsedByCamera": false,
"User": "Admin (IP: 192.168.192.41)",
"XOffset": "0",
"YOffset": "0",
"idx": "2"
}
],
"status": "OK",
"title": "Devices"
}</source>

*The array result[0] contains a hash/dict with name/value pairs of settings that are relevant to the device in question, in this example a thermostat.
*Please note that it will be something like json.result[1] in classic Lua and dzVents script because in Lua an array starts with 1.

==Retrieve name / idx of all devices==

If you are not sure of the IDX and want to do a quick lookup of name/value pairs to match a device name to its IDX, use

/json.htm?type=command&param=devices_list

which will result in something like (fragment)

<source lang="json">
{
"name" : "Corner Light",
"value" : "156"
},
{
"name" : "Table Light",
"value" : "198"
},
</source>

==Get status of all devices of a certain type==

<code>/json.htm?type=command&param=getdevices&filter=all&used=true&order=Name</code>

This will return information about all used devices. If you want to retrieve information for a specific devicetype, you can use the following filters with &filter=:

light
weather
temp
utility
wind
rain
uv
baro
zwavealarms

<source lang="json">{
"ActTime": 1615581479,
"AstrTwilightEnd": "20:34",
"AstrTwilightStart": "05:09",
"CivTwilightEnd": "19:15",
"CivTwilightStart": "06:29",
"DayLength": "11:39",
"NautTwilightEnd": "19:54",
"NautTwilightStart": "05:50",
"ServerTime": "2021-03-12 21:37:59",
"SunAtSouth": "12:52",
"Sunrise": "07:02",
"Sunset": "18:41",
"app_version": "2020.2 (build 13065)",
"result": [
{
"List of all devices": 1
}
],
"status": "OK",
"title": "Devices"
}</source>

==Get status of all devices, including hidden ones==

<code>/json.htm?type=command&param=getdevices&used=true&displayhidden=1</code>

Device names starting with a '$' sign are invisible in both the ''Dashboard'' and ''Switches'' tabs in the Domoticz UI. If you want these devices included in the json output then ''displayhidden'' must be specified.

<source lang="json">{
"ActTime": 1615641865,
"AstrTwilightEnd": "20:36",
"AstrTwilightStart": "05:07",
"CivTwilightEnd": "19:16",
"CivTwilightStart": "06:26",
"DayLength": "11:43",
"NautTwilightEnd": "19:56",
"NautTwilightStart": "05:47",
"ServerTime": "2021-03-13 14:24:25",
"SunAtSouth": "12:51",
"Sunrise": "07:00",
"Sunset": "18:43",
"app_version": "2020.2 (build 13065)",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
...
"Name": "$Harmony_Mediacenter",
"Notifications": "false",
"PlanID": "0",
...
"YOffset": "0",
"idx": "2176"
},
],
"status": "OK",
"title": "Devices"
}
</source>

==Get status of all Favorite devices==

<code>/json.htm?type=command&param=getdevices&used=true&filter=all&favorite=1</code>

This will return only devices that are tagged as Favorite.
==Get server time==

/json.htm?type=command&param=getServerTime

<source lang="json">{
"ServerTime": "2021-01-13 23:10:13",
"status": "OK",
"title": "getServerTime"
}</source>

==Get sunrise and sunset times==

/json.htm?type=command&param=getSunRiseSet

<source lang="json">{
"ServerTime" : "Sep 30 2013 17:15:21",
"Sunrise" : "07:38:00",
"Sunset" : "19:16:00",
"status" : "OK",
"title" : "getSunRiseSet"
}</source>

==Use Notification Subsystem==

You can post a notification to all enabled notification systems with:

/json.htm?type=command&param=sendnotification&subject=SUBJECT&body=THEBODY

<source lang="json">{
"status": "OK",
"title": "SendNotification"
}</source>

You can also post a notification to one or more notification systems with:

/json.htm?type=command&param=sendnotification&subject=SUBJECT&body=THEBODY&subsystem=SUBSYSTEM1;SUBSYSTEM2;...&extradata=EXTRADATA1;EXTRADATA2;....

*SUBJECT = a string you want to use as subject
*THEBODY= a string you want to use as body
*SUBSYSTEM= the notification system(s) you want to use (lowercase)
*EXTRADATA=Some subsystems can have extra data like for example FCM can have the specigic devices to be notified eg extradata=midx_7

Subsystems:
fcm
http
kodi
lms
nma
prowl
pushalot
pushbullet
pushover
pushsafer

==Backup and database related==

send a VACUUM request to domoticz database; sqlite.org: "The VACUUM command rebuilds the database file, repacking it into a minimal amount of disk space "

Please note that this command does require free space on the used temporary file system up to twice the current databases size.

See [[https://sqlite.org/tempfiles.html sqlite.org] ] goto ''' 5.Temporary File Storage Locations '''

<source lang="http">json.htm?type=command&param=vacuumdatabase</source>
<source lang="json">
{
"status": "OK",
"title": "VacuumDatabase"
}
</source>

<source lang="http">/backupdatabase.php</source>

this call will create a database backup in the download directory of your workstation.

==Event system==

Get overview of (internal) events

From Stable 2023.2: <code>/json.htm?type=command&param=events&evparam=list</code>

Deprecated format (no fallback possible!) <code><s>/json.htm?type=events&param=list</s></code><source lang="json">
{
"interpreters": "Blockly:Lua:dzVents:Python",
"result": [
{
"eventstatus": "0",
"id": "77",
"name": "Lua pinger"
},
{
"eventstatus": "0",
"id": "106",
"name": "Lua curl"
},
....
}
],
"status": "OK",
"title": "ListEvents"
}
</source>
Deprecated format (no fallback possible!) <code><s>/json.htm?type=events&param=updatestatus&eventid=77&eventstatus=1</s></code>

From Stable 2023.2: <code>/json.htm?type=command&param=events&evparam=updatestatus&eventid=77&eventstatus=1</code><source lang="json">
{
"status": "OK",
"title": "Events"
}
</source>

==Accept new sensors==

<source lang="http">/json.htm?type=command&param=allownewhardware&timeout=MINUTES</source>

<source lang="json">
{
"status": "OK",
"title": "AllowNewHardware"
}
</source>

==Get list of custom icons==

<source lang="http">/json.htm?type=command&param=getcustomiconset</source>
Add 100 to the Idx value to use it in the [[Domoticz API/JSON URL's#change Icon Not available for all device types|set Custom icon command]].
So listed Idx: 2 is iconNumber 102 for the command.
<source lang="json">
{
"result": [
{
"Description": "OpenAQ",
"IconFile16": "images/xfr_openaq2.png",
"IconFile48Off": "images/xfr_openaq248_Off.png",
"IconFile48On": "images/xfr_openaq248_On.png",
"Title": "OpenAQ",
"idx": 1
},
{
"Description": "Omnik Logo",
"IconFile16": "images/Omnik.png",
"IconFile48Off": "images/Omnik48_Off.png",
"IconFile48On": "images/Omnik48_On.png",
"Title": "Omnik",
"idx": 2
}
],
"status": "OK",
"title": "GetCustomIconSet"
}
</source>

=Lights and switches=

==Get details of all lights/switches==

/json.htm?type=command&param=getlightswitches

OR

<code>/json.htm?type=command&param=getdevices&filter=light&used=true&order=Name</code>

Example output:
<source lang="json">

{
"result" : [
{
"IsDimmer" : false,
"Name" : "Bedroom lights",
"SubType" : "Energenie",
"Type" : "Lighting 1",
"idx" : "43"
},
{
"IsDimmer" : false,
"Name" : "Hall",
"SubType" : "Energenie",
"Type" : "Lighting 1",
"idx" : "30"
},
{
"IsDimmer" : true,
"Name" : "Lounge Light Front",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "32"
},
{
"IsDimmer" : true,
"Name" : "Lounge Lights All",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "66"
},
{
"IsDimmer" : true,
"Name" : "Lounge light back",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "33"
}
],
"status" : "OK",
"title" : "GetLightSwitches"
}
</source>

==Turn a light/switch on/off==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=<On|Off|Toggle|Stop>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>
When error:
<source lang="json">{
"message" : "Error sending switch command, check device/hardware (idx=nnn) !",
"status" : "ERROR",
"title" : "SwitchLight"
}</source>
==Open-Close-Stop Blinds==

Open-Close Blinds

/json.htm?type=command&param=switchlight&idx=99&switchcmd=<Open|Close|Stop>

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Set%20Level&level=<0..100>

==General notes==

Commands are case sensitive!

Beware that if the switch has the 'protected' attribute set then you need add key `passcode` (with the right passcode)

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Off&passcode=YOUR_SWITCH_PASSWORD_AS_SET_IN_SETTINGS

or the status will be

<source lang="json">{
"message" : "WRONG CODE",
"status" : "ERROR",
"title" : "SwitchLight"
}</source>

Note that when you use '''&switchcmd''', the http:// or script:// on/off actions of the corresponding switch are executed. If you just want to update the status of the switch in Domoticz ''without'' running these actions, use the '''&param=udevice''' option instead (see update-section below).

==Switching RFY Blinds sun/wind detector on/off==

On some type of blinds it is possible to enable/disable the sun/wind detector.

Enable (where the number behind idx is the idx number of the screen in domoticz):
/json.htm?type=command&param=switchlight&idx=7&switchcmd=EnableSunWind
Disable:
/json.htm?type=command&param=switchlight&idx=7&switchcmd=DisableSunWind

==Set a dimmable light/selector to a certain level==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Set%20Level&level=6

*dimmable:
**Some lights have 100 dim levels (like zwave and others), other hardware (kaku/lightwaverf) have other ranges like 16/32
**Level should be the dim level (not percentage), like 0-16 or 0-100 depending on the hardware used
**When the light is off, it will be turned on
*Blinds: enter percentage, level will be 0-100
*Selector switch: enter the level number (eg 10, 20 or 30) that can be found in the edit section of a switch.
*To update in Domoticz only without running it's device actions use <code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=[0,1,2]&svalue=LEVELNR</code> Statuses for Blinds Percentage when using &param=udevice:

Closed: nValue = 1 and sValue = 100
partially opened: nValue = 2 and sValue = 1-99
Open: nValue = 0 and sValue = 0
<source lang="json">{
"status" : "OK",
"title" : "SwitchLight"
}</source>

==Set a light to a certain color or color temperature==

Color can be specified as either hue + brightness, RGB + optional brightness or a Domoticz JSON color object

;Specify hue and brightness
:Hue in degrees, 0..360
:Brightness 0..100

/json.htm?type=command&param=setcolbrightnessvalue&idx=99&hue=274&brightness=40&iswhite=false

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

:Note: There is no saturation parameter, specify RGB format Domoticz JSON color format for full color control

;Specify RGB and brightness (optional)
:RGB as hexadecimal number, RRGGBB without prefix (no 0x or #)

/json.htm?type=command&param=setcolbrightnessvalue&idx=99&hex=RRGGBB&brightness=100&iswhite=false

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

:Note: The actual brightness of the light is a combination of RGB value and brightness. Brightness parameter may be omitted.
:A site like [http://www.colorhexa.com/ff8c00 colorhexa] can be used to help pick hex values according to desired colours.

;Specify Domoticz JSON color object and brightness
:Example: Specify color mode with a dim blue color

/json.htm?type=command&param=setcolbrightnessvalue&idx=130&color={"m":3,"t":0,"r":0,"g":0,"b":50,"cw":0,"ww":0}&brightness=100

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

'''Domoticz color format:'''

Domoticz color format is used as:

*input parameter to:
*:- setcolbrightnessvalue
*:- updatetimer
*:- addtimer
*:- addscenedevice
*:- updatescenedevice
*In response from:
*:- devices
*:- getscenedevices
*:- timers

Example: <code>color={"m":3,"t":0,"r":0,"g":0,"b":50,"cw":0,"ww":0}</code>
<nowiki>
ColorMode {
ColorModeNone = 0, // Illegal
ColorModeWhite = 1, // White. Valid fields: none
ColorModeTemp = 2, // White with color temperature. Valid fields: t
ColorModeRGB = 3, // Color. Valid fields: r, g, b.
ColorModeCustom = 4, // Custom (color + white). Valid fields: r, g, b, cw, ww, depending on device capabilities
ColorModeLast = ColorModeCustom,
};

Color {
ColorMode m;
uint8_t t; // Range:0..255, Color temperature (warm / cold ratio, 0 is coldest, 255 is warmest)
uint8_t r; // Range:0..255, Red level
uint8_t g; // Range:0..255, Green level
uint8_t b; // Range:0..255, Blue level
uint8_t cw; // Range:0..255, Cold white level
uint8_t ww; // Range:0..255, Warm white level (also used as level for monochrome white)
}
</nowiki>

'''References'''
This API call is called internally by dzVents when using the following device object methods:

*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setColor(r, g, b, br, cw, ww, m, t)]
*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setColorBrightness()]

Please ensure local access is enabled for 127.0.0.1 or 127.0.0.*
[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#Using_dzVents_with_Domoticz (described here)].
for these to work correctly. 
The parameters r, g, b, cw, ww, m and t map to the same values in the aforementioned color object. 
The parameter br maps to brightness [0..100]. 

==Set an RGB_CW_WW or CW_WW light to a certain color temperature==

/json.htm?type=command&param=setkelvinlevel&idx=99&kelvin=1

<source lang="json">{
"status": "OK",
"title": "Set Kelvin Level"
}</source>
Range of kelvin parameter: 0..100, 0 is coldest, 100 is warmest

'''References'''
This API call is called internally by dzVents when using the following device object method:

*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setKelvin(Kelvin)]

Please ensure local access is enabled for 127.0.0.1 or 127.0.0.*
[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#Using_dzVents_with_Domoticz (described here)].
for this to work correctly. 

==Toggle a switch state between on/off==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Toggle

<source lang="json">{
"status" : "OK",
"title" : "SwitchLight"
}</source>

=Cameras=
==Get cameras==
<code>/json.htm?type=command&param=getcameras</code><source lang="json">
{
"result": [
{
"Address": "192.168.192.111",
"Enabled": "true",
"ImageURL": "image.jpg",
"Name": "Inside",
"Password": "Secret",
"Port": 19767,
"Protocol": 0,
"Username": "anyUser",
"idx": "1"
},
{
"Address": "192.168.192.112",
"Enabled": "true",
"ImageURL": "image.jpg",
"Name": "Outside",
"Password": "verySecret",
"Port": 19765,
"Protocol": 0,
"Username": "anotherUser",
"idx": "2"
}
],
"status": "OK",
"title": "Cameras"
}
</source>

==Add camera==

imageurl must be base64 encoded

<source lang="json">

/json.htm?type=command&param=addcamera&address=192.168.192.111&port=19765&name=insideCamera&enabled=true&imageurl=aW1hZ2UuanBn&protocol=0

{
"status": "OK",
"title": "AddCamera"
}

</source>

==Update camera==

imageurl must be base64 encoded

<source lang="json">

/json.htm?type=command&param=updatecamera&address=192.168.192.111&port=19767&name=test&enabled=true&idx=1&imageurl=aW1hZ2UuanBn&protocol=0

{
"status": "OK",
"title": "UpdateCamera"
}

</source>

==Send snapshot from camera==

imageurl must be base64 encoded

&user&password optional

Sends email with a camera snapshots if email is configured in Menu Setup - Settings and set for attachments.

camidx: Send 1 or multiple camerIDs in ; separated.

Subject: Subject of email

<source lang="json">

/json.htm?type=command&param=emailcamerasnapshot&camidx=1;3&subject=Movement+at+Frontdoor

{
"status": "OK",
"title": "Email Camera Snapshot"
}

</source>

=Scenes / Groups=
==Get current state of all scenes & groups==

<code>/json.htm?type=command&param=getscenes</code>

Example output:
<source lang="json">{
"result" : [
{
"Favorite" : 1,
"HardwareID" : 0,
"LastUpdate" : "2013-09-29 19:11:01",
"Name" : "My Scene",
"Status" : "Off",
"Timers" : "true",
"Type" : "Scene",
"idx" : "9"
},
{
"Favorite" : 1,
"HardwareID" : 0,
"LastUpdate" : "2013-09-30 11:49:13",
"Name" : "My Group",
"Status" : "Off",
"Timers" : "false",
"Type" : "Group",
"idx" : "3"
}
],
"status" : "OK",
"title" : "Scenes"
}</source>

==Turn a scene / group on or off==

/json.htm?type=command&param=switchscene&idx=&switchcmd=<On|Off|Toggle>

*idx = id of your scene/group.
*switchcmd = "On", "Off" or "Toggle" (case sensitive!)
*Scenes can only be turned '''On'''

<source lang="json">{
"status" : "OK",
"title" : "SwitchScene"
}</source>

==Add a scene (0)==
<code>/json.htm?type=command&param=addscene&name=''scenename''&scenetype=0</code>

==Add a group (1)==
<code>/json.htm?type=command&param=addscene&name=''scenename''&scenetype=1</code>

==Delete a scene or group==
<code>/json.htm?type=command&param=deletescene&idx=''number''</code>

==List devices in a scene==
/json.htm?type=command&param=getscenedevices&idx=''number''&isscene=true

==Add device to a scene==
/json.htm?type=command&param=addscenedevice&idx=''number''&isscene=true&devidx=''deviceindex''&command=1&level=''number''&hue=''number''

==Delete device from a scene==
/json.htm?type=command&param=deletescenedevice&idx=''number''

==List activation devices of a scene==
/json.htm?type=command&param=getsceneactivations&idx=''number''

Example output:
<source lang="json">{
"result": [
{
"code": 0,
"codestr": "-",
"idx": 249,
"name": "Activator device"
},
{
"code": 0,
"codestr": "-",
"idx": 1048,
"name": "Another Activator device"
}
],
"status": "OK",
"title": "GetSceneActivations"
}</source>

==Add activation devices for a scene==

<code>/json.htm?type=command&param=addscenecode&sceneidx=<scene ID>&idx=<device ID>&cmnd=<command></code>

Example output:
<source lang="json">
{
"status": "OK",
"title": "AddSceneCode"
}</source>

==Add OnAction and OffAction to a scene or group==
This command can be issue only after a scene or group was created, so first create the scene/group, than update the scene/group specifying the On Action and/or Off Action
<code>/json.htm?type=command&param=updatescene&idx=''number''&scenetype=''scenetype''&onaction=''base64onaction''&offaction=''base64offaction''</code>

where ''number'' is the idx of the scene/group, ''scenetype'' is 0 for scenes of 1 for groups, ''base64onactions'' is the On Action coded with base64 and ''base64offaction'' is the Off Action coded with base64. It's possible to find base64 converters online, like https://www.base64encode.org/

Please note that you have to include your current description if any

Example output:

<source lang="json">{
"status": "OK",
"title": "UpdateScene"
}</source>

==List timers of a scene==
<code>/json.htm?type=command&param=getscenetimers&idx=''number''</code>

Example output:
<source lang="json">{
"result" : [
{
"Active" : "true",
"Cmd" : 0,
"Date" : "07-02-2016",
"Days" : 128,
"Hue" : 0,
"Level" : 100,
"Randomness" : true,
"Time" : "00:01",
"Type" : 5,
"idx" : "16"
}
],
"status" : "OK",
"title" : "SceneTimers"
}</source>

==Add timer to a scene==

/json.htm?type=command&param=addscenetimer&idx=''number''&active=&timertype=&date=&hour=&min=&randomness=&command=&level=&days=

*idx = index of your scene/group.
*active = true/false
*timertype = 0 = Before Sunrise, 1 = After Sunrise, 2 = On Time, 3 = Before Sunset, 4 = After Sunset, 5 = Fixed Date/Time
*date = MM-DD-YYYY
*hour = hour
*min = minute
*randomness = true/false
*command = On/Off
*level = 0..100 (%)
*days = 0x80 = Everyday, 0x100 = Weekdays, 0x200 = Weekends, 0x01 = Mon, 0x02 = Tue, 0x04 = Wed, 0x08 = Thu, 0x10 = Fri, 0x20 = Sat, 0x40 = Sun

==Enable/disable/delete specific scene schedule(timer)==
[[Domoticz_API/JSON_URL's#Enable specific schedule(timer) for Scenes/Groups|Enable specific schedule(timer) for Scenes/Groups]]

[[Domoticz_API/JSON_URL's#Disable specific schedule(timer) for Scenes/Groups|Disable specific schedule(timer) for Scenes/Groups]]

[[Domoticz_API/JSON_URL's#Delete specific schedule(timer) for Scenes/Groups|Delete specific schedule(timer) for Scenes/Groups]]

=Setpoint/Thermostat control=

==Set Setpoint==
/json.htm?type=command&param=setsetpoint&idx=IDX&setpoint=SETPOINT

*IDX = id of the setpoint
*SETPOINT = value (for temperature in Celsius (like 20.5))

For '''Thermostat6''' devices, implemented in beta 2025.2, the following update additional update API calls are available:

== Update temp/hum/baro/setpoint ==
You cannot just set the temp/Hum/baro, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;HUM;HUM_STAT;BAR;BAR_FOR</code>

Barometer forecast does not seem to work....

* IDX = id of your device (This number can be found in the devices tab in the column "IDX")
* TEMP = Temperature
* HUM = Humidity
* HUM_STAT = Humidity status
* BAR = Barometric pressure
* BAR_FOR = Barometer forecast

HUM_STAT can be one of:

* 0=Normal
* 1=Comfortable
* 2=Dry
* 3=Wet

Barometer forecast of device type "General" (Virtual) can be one of:

0 = No Info

1 = Sunny

2 = Partly Cloudy

3 = Cloudy

4 = Rain

== Update temp/setpoint ==
You cannot just set the temp, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT</code>

See temp/hum/baro/setpoint for the applicable options.

== Update temp/hum/setpoint ==
You cannot just set the temp/Hum, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;HUM;HUM_STAT</code>

See temp/hum/baro/setpoint for the applicable options.

== Update temp/baro/setpoint ==
You cannot just set the temp/baro, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;BAR;BAR_FOR</code>

Barometer forecast does not seem to work....

See temp/hum/baro/setpoint for the applicable options.

=Server control=

==Shutdown system==
/json.htm?type=command&param=system_shutdown

<source lang="json">{
"status" : "OK",
"title" : "SystemShutdown"
}</source>

==Reboot system==
/json.htm?type=command&param=system_reboot

<source lang="json">{
"status" : "OK",
"title" : "SystemReboot"
}</source>

=Create, delete, rename, action and disable commands=

==Create virtual hardware==
/json.htm?type=command&param=addhardware&htype=15&port=1&name=Sensors1&enabled=true

afterwards to get the id, either you have your last created id from an index you maintain or sort the hardware page for last ID:
<code>/json.htm?type=command&param=gethardware</code>

==Create a virtual sensor==

Basic action (see below for values)
<code>/json.htm?type=command&param=createvirtualsensor&idx=HWIDX&sensorname=SENSORNAME&sensortype=SENSORTYPE</code>

Note: It is normally easier to use the CreateDevice JSON (see next section)

Temp+Humidity example
/json.htm?type=<code>command&param=</code>createvirtualsensor&idx=HWIDX&sensorname=TempHum&sensortype=82
Electricity example
/json.htm?type=<code>command&param=c</code>reatevirtualsensor&idx=HWIDX&sensorname=Energy&sensortype=90

and then get the device id from the list:
/json.htm?type=<code>command&param=get</code>devices&filter=all&used=true&order=Name

Values:

*HWIDX = id of your (Dummy) hardware (not the device!). This number can be found in the hardware tab in the column "IDX".

Note: If a non existing hardware IDX is used the created device is greyed out in the user interface!

*SENSORNAME = sensor name
*SENSORTYPE = See list below (this is an incomplete list. For more devices see page [[Developing a Python plugin]])

1 Pressure (Bar) 0.0 nvalue=BAR (TBC)
2 Percentage 0.0 nvalue=PCT (TBC)
80 TEMP 0.0 svalue=TEMP
81 HUM 1 nvalue=HUM svalue=1 to 3
82 TEMP_HUM 0.0;50;1 svalue=TEMP;HUM;HUM_STATUS
84 TEMP_HUM_BARO 0.0;50;1;1010;1 svalue=TEMP;HUM;HUM_STATUS;BARO;BARO_FCST
85 RAIN 0;0 svalue=RAIN;Rain in mm/h
86 WIND 0;N;0;0;0;0 svalue=WIN_SPD;WIND_DIR;?;?;?;?
87 UV 0;0 svalue= (TBC)
113 RFXMeter 0 Can have several values, another order has to be sent to set the sub type:
type 5 Time: svalue=COUNTER
type 4 Energy generated: svalue=POWER;ENERGY
type 3 Counter: svalue=COUNTER
type 2 Water: svalue=VOLUME
type 1 Gas: svalue=VOLUME
type 0 Energy: svalue=POWER;ENERGY
90 ENERGY 0;0.0 svalue=POWER;ENERGY
249 TypeAirQuality 0 nvalue=PPM

For the RFXMeter another request is needed to set the utility (switchtype). URL is:
<code>/json.htm?type=command&param=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true</code>

where DEVICE_IDX is the device idx, SENSORNAME is device name, and the SUBTYPE_VALUE is one of:
0 for Energy
1 for Gas
2 for Water
3 for Custom Counter
4 for Energy Generated
5 for Time

==Create a device==
An overview of all available devices can be found in wiki page [[Developing_a_Python_plugin#Available_Device_Types]]

Basic Action:

<code>/json.htm?type=command&param=createdevice&idx=HWIDX&name=SENSORNAME&sensormappedtype=MAPPEDTYPE".</code>

*HWIDX = id of your (Dummy) hardware. This number can be found in the hardware tab in the column "IDX".

Note: If a non existing hardware IDX is used the created device is greyed out in the user interface!

*SENSORNAME = sensor name
*DEVICETYPE = type of device, see overview [[Developing_a_Python_plugin#Available_Device_Types]]

Source: https://github.com/domoticz/domoticz/blob/development/hardware/hardwaretypes.h or https://github.com/domoticz/domoticz/blob/development/main/RFXtrx.h

*DEVICESUBTYPE = subtype of device, see overview [[Developing_a_Python_plugin#Available_Device_Types]]

Source: https://github.com/domoticz/domoticz/blob/development/hardware/hardwaretypes.h or https://github.com/domoticz/domoticz/blob/development/main/RFXtrx.h

Example Result
<source lang="json">{
"idx" : "142",
"status" : "OK",
"title" : "CreateSensor"
}</source>

'''Examples:'''

Temp (Type: pTypeTEMP, subType: sTypeTEMP5)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Temp5&devicetype=50&devicesubtype=5
Voltage (Type: pTypeGeneral, subType: sTypeVoltage)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Voltage0&devicetype=243&devicesubtype=8
Electric (Instant+Counter)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=ElecInstCount&devicetype=243&devicesubtype=29
Counter Incremental
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Counter%20Increment2&devicetype=243&devicesubtype=28

For the Counter Incremental, Counter and managed Counter and Switches another request is needed to set the type(switchtype). URL is:
/json.htm?type=<code>command&param=</code>setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true
where for counters DEVICE_IDX is the device idx, SENSORNAME is device name, and the SUBTYPE_VALUE is one of:
0 for Energy
1 for Gas
2 for Water
3 for Custom Counter
4 for Energy Generated
5 for Time

For switches
SubType Name
0 On/Off
1 Doorbell
2 Contact
3 Blinds
4 X10 Siren
5 Smoke Detector
6 Blinds Inverted
7 Dimmer
8 Motion Sensor
9 Push On Button
10 Push Off Button
11 Door Contact
12 Dusk Sensor
13 Blinds Percentage
14 Venetian Blinds US
15 Venetian Blinds EU
16 Blinds Percentage Inverted
17 Media Player
18 Selector
19 Door Lock
20 Door Lock Inverted
21 Blinds Percentage with Stop
22 Blinds Percentage with Stop Inverted

== List hardware ==
<code>/json.htm?type=command&param=gethardware</code>

==Rename hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<new name>&enabled=<true or false>&idx=<hardware idx>
 
To get the required data from the hardware first do
<code>/json.htm?type=command&param=gethardware</code> 

==Rename device / sensor==
<code>/json.htm?type=command&param=setused&idx=<device ID>&name=<new name>&used=true</code> 

==Enable hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<name>&enabled=true&port=<port name>&idx=<hardware idx>&loglevel=<log level>

'''note''' Use the complete set of parms that you find when entering the enable command on the GUI because if not completely entered it will destroy your hardware table. Test first on a test system !!

==Disable hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<name>&enabled=false&idx=<hardware idx>
To get the required data from the hardware first do
 
<code>/json.htm?type=command&param=gethardware</code>

 
'''note''' Use the complete set of parms that you find when entering the disable command on the GUI because if not completely entered it will remove data from the parms. Test on a test system first !!

==Delete hardware==
/json.htm?type=command&param=deletehardware&idx=<hardware idx>

<source lang="json">{
"status" : "OK",
"title" : "DeleteHardware"
}</source>

==Delete a device or sensor==
<code>/json.htm?type=command&param=setused&used=false&idx=<device idx></code><source lang="json">{
"status" : "OK",
"title" : "SetUsed"
}</source>

==Enable/Disable a device or sensor==
/json.htm?type=command&param=setdevused&idx=<device idx>&used=<true/false>&name=<device name>
(device name is a optional parameter)
<source lang="json">{
"status" : "OK",
"title" : "SetDeviceUsed"
}</source>

==Enable a disabled device or sensor==

/json.htm?idx=<device idx>&name=<new name>&type=setused&used=true
or
/json.htm?idx=<device idx>&type=setused&used=true

<source lang="json">{
"status" : "OK",
"title" : "SetUsed"
}</source>

==Add an On action and/or an Off action to a device or sensor==

/json.htm?type=setused&used=true&idx=IDX&strparam1=base64Encoded(ON ACTION STRING)&strparam2=base64Encoded(OFF ACTION STRING)

<source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

==Transfer device==

<code>/json.htm?type=command&param=dotransferdevice&idx=IDX_1&newidx=IDX_2</code>

Transfer sensor log of device with oldest lastUpdate value to device with most recent lastUpdate value. So not necessarily from IDX_1 to IDX_2 or the other way around.
Source device is removed after transfer of logs.

<source lang="json">{
"status": "OK",
"title": "TransferDevice"
}</source>

=Update devices/sensors=
Note that when you use this &param=udevice option with the additional option &parsetrigger=false, the device is updated ''without'' running the associated on/off- and script actions.

Expert usage. Directly set device parameters via JSON.
 

Be careful when firing values to domoticz.db as there is a chance to crash the database if parameters are wrong or missing.
First go to the devices tab and notice the device index (idx) of the device you want to change 

==Generic update API's==

Note make sure stringparms must be urlenecoded (eg. <space> %20, <Double quote> %27 etc..

===update a sensor device===
Note: for switches/lights/dimmers see Lights and Switches section.

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

===change Icon Not available for all device types===

<code>/json.htm?type=command&param=setused&used=true&name=<devicename>&description=<description>&idx=<idx>&switchtype=<switchType>&customimage=<iconNumber></code>

Use the [[Domoticz API/JSON URL's#Get list of custom icons|getcustomiconset command]] to get a list of all custom icons. Add 100 the given Idx value to set the iconnumber. So listed Idx:2 is iconNumber 102<source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

===change name===

/json.htm?type=command&param=renamedevice&name=<new devicename>&idx=<idx>

<source lang="json">{
"status": "OK",
"title": "RenameDevice"
}</source>

===protection On / Off===

<code>/json.htm?type=command&param=setused&used=true&protected=<true/falseidx=<idx></code><source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

===update in domoticz only===

does not parse the actual command to the hardware (like MQTT)

with parsetrigger=false -->> No event is triggered either

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>&parsetrigger=<false/true>

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 

 
<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Humidity==
/json.htm?type=command&param=udevice&idx=IDX&nvalue=HUM&svalue=HUM_STAT

The above sets the parameters for a Humidity device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*HUM = Humidity: 45% 
*HUM_STAT = Humidity_status 

 
Humidity_status can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=BAR;BAR_FOR

The above sets the parameters for a Barometer device from hardware type 'General' 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 

 
Barometer forecast can be one of: 
0 = Stable 
1 = Sunny 
2 = Cloudy 
3 = Unstable 
4 = Thunderstorm 
5 = Unknown 
6 = Cloudy/Rain 

 

Barometer forecast of other device types can be one of: 
0 = Heavy Snow 
1 = Snow 
2 = Heavy Rain 
3 = Rain 
4 = Cloudy 
5 = Some Clouds 
6 = Sunny 
7 = Unknown 
8 = Unstable 
9 = Stable 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/humidity==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;HUM;HUM_STAT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*HUM = Humidity (0-100 %) 
*HUM_STAT = Humidity status 

 
HUM_STAT can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 
<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/humidity/barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;HUM;HUM_STAT;BAR;BAR_FOR

The above sets the parameters for a Temp+Humidity+Barometer device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*HUM = Humidity 
*HUM_STAT = Humidity status 
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 

 
HUM_STAT can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 
Barometer forecast of device type "General" (Virtual) can be one of: 

0 = No Info 
1 = Sunny 
2 = Partly Cloudy 
3 = Cloudy 
4 = Rain 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;BAR;BAR_FOR;ALTITUDE

The above sets the parameters for a Temp+Humidity+Barometer device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 
*ALTITUDE= Optional. Not used at the moment, can be 0 

 
Barometer forecast can be one of: 
0 = Stable 
1 = Sunny 
2 = Cloudy 
3 = Unstable 
4 = Thunderstorm 
5 = Unknown 
6 = Cloudy/Rain 
 

Barometer forecast of other device types can be one of: 
0 = Heavy Snow 
1 = Snow 
2 = Heavy Rain 
3 = Rain 
4 = Cloudy 
5 = Some Clouds 
6 = Sunny 
7 = Unknown 
8 = Unstable 
9 = Stable 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Rain==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=RAINRATE;RAINCOUNTER

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*RAINRATE = amount of rain in last hour in [mm x 100]
*RAINCOUNTER = continues counter of fallen Rain in [mm]

==Soil Moisture==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=MOISTURE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*MOISTURE = moisture content in cb 0-200 where:

00 - 09 = saturated,
10 - 19 = adequately wet,
20 - 59 = irrigation advice,
60 - 99 = irrigation,
100-200 = Dangerously dry,

==Wind==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=WB;WD;WS;WG;22;24

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*WB = Wind bearing (0-359) 
*WD = Wind direction (S, SW, NNW, etc.) 
*WS = 10 * Wind speed [m/s] 
*WG = 10 * Gust [m/s] 
*22 = Temperature 
*24 = Temperature Windchill 

==UV==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=UV;TEMP

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*UV = Float (example: 2.1) with current UV reading. 
*TEMP = temperature (only for UV subtype TFA (3), else specify 0)

Don't loose the ";0" at the end - without it database may corrupt.

If no temp is in use, specify 0 as temperature

==Counter==

/json.htm?type=command&param=udevice&idx=IDX&svalue=COUNTER

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*COUNTER = Integer of the overall total counter (Energy, Volume, Custom). 

When there is a counter created, there is a possibility to change the units by clicking on "Change" at the utility tab.

*Energy (reports kWh), give COUNTER value in Wh, integer 
*Energy Generated (reports kWh). give COUNTER value in Wh, integer 
*Gas (reports m3) , give COUNTER value in liter (1000 liter = 1 m³), integer 
*Water (reports m3), give COUNTER value in liter (1000 liter = 1 m³), integer 
*Counter (no unit) 
*Time (min?), seems to be obsolete, use Counter instead and use the time units as desired (eg Sec, min, hrs) 

The counter will be treated with the divider which is defined in the parameters in the application settings (menu setup-settings, tab counters). For example if the counter is set to "Water" and the value is passed as liters, the divider must set to 1000 (as the unit is m3).

The divider should also be used on Cutom if you want to report on digits. Eg if you set Unit to Euro but want to report on cents (eg 0.30) then you have to supply the value in cents (1 euro = 100 cents) and use the divider 100.

The device displays 2 values: 

*The status is the overall total volume (or counter). 
*The volume (or counter) of the day (in the top right corner). 

The today's volume (or counter) is calculated from the total volume (or counter).

==Counter Incremental==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=INCREMENT

INCREMENT = Integer of the increment of the counter. For Counters the standard counter dividers apply (menu setup - settings - tab counters), see also the normal Counter description above.

It will increment the counter value by the value supplied in svalue. To reset an incremental counter, set the svalue to a ''negative'' integer equal to the current total of the counter.

==Electricity (instant and counter)==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=POWER;ENERGY

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*POWER = current power (W)
*ENERGY = Integer, total cumulative energy in Watt-hours (Wh) 

(Energy Read type (use edit button to change): Default: From Device. If the device is not able to send the ENERGY counter values you choose "Energy read : Computed". This will ignore ENERGY counter values and Domoticz will calculate the Energy (kWh) internally based on the (previous/current) POWER (Watt) values. By design this is less accurate then using the ENERGY counter when using them "from Device".)

Domoticz will calculate the today values based on the delta's in the total cumulative energy of today.

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

Note: This device will show in Domoticz as type "General, kWh"

==Managed counter==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = Integer, total cumulative counter energy (Wh, can be set to -1 if unknown or unused, in that case it won't show on dashboard or in logs)
*USAGE = energy usage in Watt-hours (Wh).

Managed counter will not transfer automatically every day data from device status to history log, it's up to an external script or plugin to insert data in history log database (useful to show non realtime consumption of energy provider that put energy information "in the cloud").

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

To insert data in history log:
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = total cumulative counter energy (Wh, can be set to -1 if unknown or unused, in that case it won't show on dashboard or in logs)
*USAGE = energy usage in Watt-hours (Wh)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

==Electricity Current/Ampere 3 Phase==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=Ampere_1;Ampere_2;Ampere_3;

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*Ampere_1 = Ampere value Phase 1
*Ampere_2 = Ampere value Phase 2
*Ampere_3 = Ampere value Phase 3

==Electricity P1 smart meter==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*USAGE1= integer, total cumulative energy usage meter tariff 1 in Wh.
*USAGE2= integer, total cumulative energy usage meter tariff 2 in Wh.
*RETURN1= integer, total cumulative energy return meter tariff 1 in Wh.
*RETURN2= integer, total cumulative energy return meter tariff 2 in Wh.
*CONS= actual usage power (Watt)
*PROD= actual return power (Watt)

USAGE and RETURN are total cumulative counters (they should only count up). 
For USAGE and RETURN supply the data in total Wh with no decimal point. 
(So if your meter displays f.i. USAGE1= 523,66 KWh you need to send 523660) 
Domoticz will calculate the today values based on the delta's in the total cumulative energy of today.

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

==Air quality==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=PPM

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*PPM = CO2-concentration

Calculated status from PPM value:

airquality < 700 status text: "Excellent"

airquality < 900 status text: "Good"

airquality < 1100 status text:"Fair"

airquality < 1600 status text: "Mediocre"

airquality >= 1600 status text: "Bad"

==Pressure==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=BAR

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*BAR = Pressure in Bar

Create sensor under Hardware > Dummy > Create virtual sensor

==Percentage==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=PERCENTAGE

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*PERCENTAGE = Percentage

==Visibility==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VISIBILITY

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*VISIBILITY = in KM

==Gas==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE

*USAGE= Integer, Gas usage in liter (1000 liter = 1 m³) 

So if your gas meter shows f.i. 145,332 m³ you should send 145332. 
The USAGE is the total usage in liters from start, not f.i. the daily usage.
For Counters the divider is used from menu setup - settings, tab Counters

==Lux==

/json.htm?type=command&param=udevice&idx=IDX&svalue=VALUE

*IDX = device ID of Lux device
*VALUE = value of luminosity in Lux (INTEGER/FLOAT)

==Voltage==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VOLTAGE

*IDX = device ID of Voltage device
*VALUE = value of voltage sensor in Volts

Create sensor under Hardware > Dummy > Create virtual sensor

==Text sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEXT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEXT = Text you want to display

==Alert sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=LEVEL&svalue=TEXT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*Level = (0=gray, 1=green, 2=yellow, 3=orange, 4=red)
*TEXT = Text you want to display

==Distance sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=DISTANCE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*DISTANCE = distance in cm or inches, can be in decimals. For example 12.6

==Selector Switch==

/json.htm?type=command&param=switchlight&idx=IDX&switchcmd=Set%20Level&level=LEVEL

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*LEVEL = level of your selector (This number can be found in the edit selectors page, in the column "Level", 0 = Off)

==Custom Sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VALUE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*VALUE = Value (like 12.345) 

==Opentherm Gateway Custom command==

/json.htm?type=command&param=sendopenthermcommand&idx=IDX&cmnd=COMMAND

*IDX = id of your hardware Opentherm device (This number can be found in the ID column in menu Setup-Hardware)
*COMMAND = The actual custom OTGW command like TC=20 

==Note on counters==
Usually, counters are updated daily to feed week/month/year history log views. Starting version 4.11774, if you want to disable that behavior to control everything from an external script or a plugin (already the case for managed counter), you can set the "'''DisableLogAutoUpdate'''" device option to "'''true'''", for instance in a Python plugin:
Domoticz.Device(Name="MyCounter", Unit=1, Type=0xfa, Subtype=0x01, Options={"DisableLogAutoUpdate" : "true").Create()

Starting version 4.11774, you can too directly insert data in in history log. Set the "'''AddDBLogEntry'''" device option to "'''true'''", for instance in a Python plugin:
Domoticz.Device(Name="MyCounter", Unit=1, Type=0xfa, Subtype=0x01, Options={"AddDBLogEntry" : "true").Create()
With a json the parameter AddDBLogEntry:true should first base64 encoded
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=CODE
To set AddDBLogEntry:true, you must call:
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=QWRkREJMb2dFbnRyeTp0cnVl

AddDBLogEntry can be combined with other entries in the options field if separated by a semicolon for example to set:
ValueQuantity:2;AddDBLogEntry:true

You call:
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=VmFsdWVRdWFudGl0eToyO0FkZERCTG9nRW50cnk6dHJ1ZQ==
Also please note if the device is edited using the domoticz device screen then this AddDBLogEntry disappears and needs to be added again.

Then, depending on counters, you can insert values in history log. For most counters:
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = total cumulative counter energy (Wh)
*USAGE = energy usage in Watt-hours (Wh)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

Note: COUNTER and USAGE should be positive. Any negative value will result in 0 instead

For multi meters (P1 Smart Meter, CM113, Electrisave and CM180i):
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*USAGE1= energy usage meter tariff 1, This is an incrementing counter
*USAGE2= energy usage meter tariff 2, This is an incrementing counter
*RETURN1= energy return meter tariff 1, This is an incrementing counter
*RETURN2= energy return meter tariff 2, This is an incrementing counter
*CONS= actual usage power (Watt)
*PROD= actual return power (Watt)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

or
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD;COUNTER1;COUNTER2;COUNTER3;COUNTER4;DATE
as previously, plus absolute counter values
 

==Additional parameters (signal level & battery level)==
There are two additional and optional parameters for the above commands, to specify the '''signal level''' (default 12) and the '''battery level''' (default 255) 

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>&rssi=<numeric value>&battery=<numeric value>

battery level 255 = no battery device, else 0-100 
example: '''&rssi=10&battery=89'''

=Security=

==Get Password==
to be able to set the security status, the (encoded) password is required.

<code>/json.htm?type=command&param=getsettings</code><source lang="json">{
"AcceptNewHardware": 0,
"ActiveTimerPlan": 2,
"AllowWidgetOrdering": 1,
"AuthenticationMethod": 1,
"BatterLowLevel": 0,
"CM113DisplayType": 0,
.....
"SecPassword": "bfa2bea3x",
....
"WindUnit": 4,
"cloudenabled": true,
"status": "OK",
"title": "settings"
}</source>

get the value from key "SecPassword" ;for the purpose of this wiki we assume the value read is "bfa2bea3x"

==Get security state==
/json.htm?type=command&param=getsecstatus
<source lang="json">{
"secondelay": 2,
"secstatus": 1,
"status": "OK",
"title": "GetSecStatus"
}</source>
where secstatus is
0 = Disarmed
1 = Arm Home
2 = Arm Away
3 = Unknown

==Set security state==
/json.htm?type=command&param=setsecstatus&secstatus=<status>&seccode=bfa2bea3x
<source lang="json">{
"status": "OK",
"title": "SetSecStatus"
}</source>

=Smoke Detection=
==Activate==
<code>/json.htm?type=command&param=switchlight&idx=<IDX>&switchcmd=On</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>

==Deactivate==
<code>/json.htm?type=command&param=switchlight&idx=<IDX>&switchcmd=Off</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>
==Reset==
<code>/json.htm?type=command&param=resetsecuritystatus&idx=<IDX>&switchcmd=Off</code>
<source lang="json">{
"status": "OK",
"title": "ResetSecurityStatus"
}</source>

<code>/json.htm?type=command&param=resetsecuritystatus&idx=3456&switchcmd=Normal</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>

=User variables=

==Add a new variable==

*USERVARIABLENAME with the name of the variable
*USERVARIABLETYPE is a digit (0,1,2,3,4) or a string (Integer, Float, String, Date, Time)

0 = Integer, e.g. -1, 1, 0, 2, 10
1 = Float, e.g. -1.1, 1.2, 3.1
2 = String
3 = Date in format DD/MM/YYYY
4 = Time in 24 hr format HH:MM

*USERVARIABLEVALUE with the value

All formats are checked by the api, when the variable does not match the required format it is not stored.

/json.htm?type=command&param=adduservariable&vname=USERVARIABLENAME&vtype=USERVARIABLETYPE&vvalue=USERVARIABLEVALUE

<source lang="json">{
"status": "OK",
"title": "AddUserVariable"
}</source>

==Update an existing variable==

Remember to change:

*USERVARIABLENAME with the name of your variable
*USERVARIABLETYPE according to the table from [[Domoticz_API/JSON_URL's#Add_a_new_variable|"Add a new variable"]]
*USERVARIABLEVALUE with the new value

Note: events will only be triggered when the variabletype and variablename are not changed by the update command.

/json.htm?type=command&param=updateuservariable&vname=USERVARIABLENAME&vtype=USERVARIABLETYPE&vvalue=USERVARIABLEVALUE

<source lang="json">{
"status": "OK",
"title": "UpdateUserVariable"
}</source>

==List all variables==

/json.htm?type=command&param=getuservariables

<source lang="json">{
"result": [
{
"LastUpdate": "2020-01-13 09:04:17",
"Name": "setup-test",
"Type": "2",
"Value": "Hi",
"idx": "1"
},
{
"LastUpdate": "2020-02-17 16:48:03",
"Name": "presence-test",
"Type": "0",
"Value": "1",
"idx": "2"
},
....
{
"LastUpdate": "2021-03-02 21:10:54",
"Name": "UV_Night",
"Type": "2",
"Value": "21:11",
"idx": "44"
}
],
"status": "OK",
"title": "GetUserVariables"
}
</source>

==List one variable==

/json.htm?type=command&param=getuservariable&idx=IDX

*IDX = id of your variable (This number can be found using the "List all variables" call above)

<source lang="json">{
"result": [
{
"LastUpdate": "2021-03-02 21:10:54",
"Name": "UV_Night",
"Type": "2",
"Value": "21:11",
"idx": "44"
}
],
"status": "OK",
"title": "GetUserVariable"
}</source>

==Delete a variable==

*IDX = id of your variable (This number can be found using the "List all variables" call above)

/json.htm?type=command&param=deleteuservariable&idx=IDX

<source lang="json">{
"status": "OK",
"title": "DeleteUserVariable"
}</source>

=trigger dzVents script using customEvent dzVents 3.0.0=

/json.htm?type=command&param=customevent&event=MyEvent&data=MyData

<source lang="json">{
"status": "OK",
"title": "Custom Event"
}</source>

=Room Plans=

==List all rooms==

<code>/json.htm?type=command&param=getplans&order=name&used=true</code>
<source lang="json">{
"result": [
{
"Devices": 6,
"Name": "Google Calendars",
"Order": "2",
"idx": "2"
},
{
"Devices": 2,
"Name": "Private",
"Order": "3",
"idx": "3"
},
{
"Devices": 1,
"Name": "EVOHome",
"Order": "4",
"idx": "4"
},
{
"Devices": 0,
"Name": "testPlan",
"Order": "5",
"idx": "5"
}
],
"status": "OK",
"title": "Plans"
}</source>

==List all devices in a room==

*IDX = id of your room

/json.htm?type=command&param=getplandevices&idx=IDX
Show idx, name of the device like:
<source lang="json">{
"result": [
{
"DevSceneRowID": "492",
"Name": "device name",
"devidx": "492",
"idx": "9",
"order": "9",
"type": 0
}
],
"status": "OK",
"title": "GetPlanDevices"
}</source>

/json.htm?type=devices&plan=IDX
show details of the devices like

<source lang="json">{
"ActTime": 1569909986,
"AstrTwilightEnd": "21:14",
"AstrTwilightStart": "05:50",
"CivTwilightEnd": "19:54",
"CivTwilightStart": "07:09",
"DayLength": "11:39",
"NautTwilightEnd": "20:34",
"NautTwilightStart": "06:30",
"ServerTime": "2019-10-01 08:06:26",
"SunAtSouth": "13:32",
"Sunrise": "07:42",
"Sunset": "19:21",
"app_version": "4.11337",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
"AddjValue2": 0,
"BatteryLevel": 255,
"CustomImage": 0,
"Data": "19.5 C, (13.5 C), PermanentOverride",
"Description": "",
"Favorite": 1,
"HardwareID": 30,
"HardwareName": "Evohome",
"HardwareType": "Evohome via Web API",
"HardwareTypeVal": 75,
"HaveTimeout": false,
"ID": "1168736",
"LastUpdate": "2019-10-01 08:05:35",
"Name": "Device name",
"Notifications": "false",
"PlanID": "4",
"PlanIDs": [
4
],
"Protected": false,
"SetPoint": 13.5,
"ShowNotifications": true,
"SignalLevel": 10,
"Status": "PermanentOverride",
"SubType": "Zone",
"Temp": 19.5,
"Timers": "false",
"Type": "Heating",
"TypeImg": "override_mini",
"Unit": 7,
"Used": 1,
"XOffset": "0",
"YOffset": "0",
"idx": "492"
}
],
"status": "OK",
"title": "Devices"
}</source>

=Timer Plans=

==List all Timerplans==

<code>/json.htm?type=command&param=gettimerplans</code>
<source lang="json">{
"result": [
{
"Active": false,
"Name": "Default",
"idx": 0
},
{
"Active": true,
"Name": "Holiday",
"idx": 1
},
{
"Active": false,
"Name": "Day off (including weekend)",
"idx": 2
}
],
"status": "OK",
"title": "GetTimerPlans"
}</source>

==Add Timerplan==

<code>/json.htm?type=command&param=addtimerplan&name=newTimerplan</code>
<source lang="json">{
"status": "OK",
"title": "AddTimerPlan"
}</source>

==Change Timerplan name==

<code>/json.htm?type=command&param=updatetimerplan&idx=3&name=newname</code>
<source lang="json">{
"status": "OK",
"title": "UpdateTimerPlan"
}</source>

==Duplicate Timerplan==

This will copy all existing timers from timerplan with idx 3 to a new plan

<code>/json.htm?type=command&param=duplicatetimerplan&idx=3&name=duplicatename</code>
<source lang="json">{
"status": "OK",
"title": "DuplicateTimerPlan"
}</source>

==Make Timerplan active==

This will make the timerplan with idx 2 the active one

<code>/json.htm?type=command&param=setactivetimerplan&ActiveTimerPlan=2</code>
<source lang="json">{
"status": "OK",
"title": "SetActiveTimerPlan"
}</source>

=History=

==Switch/Light devices==
<code>/json.htm?type=command&param=getlightlog&idx=IDX</code>

Shows the log entries of the IDX switch/light device.

===Delete history log===
<code>/json.htm?type=command&param=clearlightlog&idx=<idx></code>

Deletes all the log entries from the DB for a specific IDX and device displays the current switch/light state.

==Text devices==
<code>/json.htm?type=command&param=gettextlog&idx=IDX</code>

Shows the log entries of the IDX text device.

===Delete history log===
<code>/json.htm?type=command&param=clearlightlog&idx=<idx></code>

Deletes all the log entries from the DB for a specific IDX and text device displays the current text.

==Temperature==
<code>/json.htm?type=command&param=graph&sensor=temp&idx=IDX&range=[day|month|year]&actyear=YYYY</code>

==Custom sensor==

Totals by period :
<code>/json.htm?type=command&param=graph&sensor=Percentage&idx=IDX&range=day</code><source lang="json">{{
"result" :
[
{
"d" : "2021-02-04 16:40",
"v" : "308.6"
},
{
"d" : "2021-02-04 16:45",
"v" : "308.6"
},
.....

],
"status" : "OK",
"title" : "Graph Percentage day"
}
</source>

<code>/json.htm?type=command&param=graph&sensor=Percentage&idx=IDX&range=[day|month|year|year&actyear=YYYY]</code><source lang="json">{
"result" :
[
{
"d" : "2021-01-18",
"v_avg" : "308.6",
"v_max" : "309.6",
"v_min" : "307.6"
},
{
"d" : "2021-01-19",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
},
{
"d" : "2021-01-21",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
},
...

{
"d" : "2021-02-18",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
}
],
"status" : "OK",
"title" : "Graph Percentage <...>"
}
</source>

==Energy, Gas, Water==

Instantaneous consumption :

/json.htm?type=command&param=graph&sensor=counter&idx=IDX&range=day&method=1

Totals by period :
<code>/json.htm?type=command&param=graph&sensor=counter&idx=IDX&range=[day|month|year|year&actyear=YYYY|YYYY-MM-DDTYYYY-MM-DD]</code>

Only for counters it is possible to specify a date range for long history data (not for short log data):
&range=YYYY-MM-DDTYYYY-MM-DD
Notice the "T" between the dates in range.

==Deleting History log entries==

===delete a single data point or day===

/json.htm?type=command&param=deletedatapoint&idx=IDX&date=DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*DATE = date in %Y-%m-%d format (for instance 2021-02-26) will delete history data of that particular day (one entry from long term history and max 120 entries from short term history log)
*DATE = date in "%Y-%m-%d%20%H:%M:%S" format (for instance 2019-10-03%2014:00:00) will delete history data of that particular time (one entry from short term history log)

<source lang="json">{
"status": "OK",
"title": "deletedatapoint"
}
</source>

===delete a date range of data points===

/json.htm?type=command&param=deletedaterange&idx=IDX&fromdate=FROMDATE&todate=TODATE V2020.2 build >= 13027 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*FROMDATE = date in %Y-%m-%d or date in "%Y-%m-%d%20%H:%M:%S"format (for instance 2021-02-26 / 2019-10-03%2014:00:00) will delete history data (from short and long history tables) starting with that day / time
*TODATE = date in %Y-%m-%d or date in "%Y-%m-%d%20%H:%M:%S"format (for instance 2021-02-26 / 2019-10-03%2014:00:00) will delete history data (from short and long history tables) ending with that day / time

<source lang="json">{
"status": "OK",
"title": "deletedaterange"
}
</source>

=Device Timer Schedules=
==Get all schedules (timers)==
/json.htm?type=command&param=getschedules

<source lang="json">{
"result" : [
{
"Active" : "true",
"Date" : "",
"Days" : 128,
"DevName" : "Porch Light",
"DeviceRowID" : 52,
"Hue" : 0,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2016-04-01 20:33:00",
"Time" : "00:20",
"TimerCmd" : 0,
"TimerID" : 9,
"TimerType" : 4,
"TimerTypeStr" : "After Sunset",
"Type" : "Device"
},
</source>

==Get all schedules(timers) for all Devices==

/json.htm?type=command&param=getschedules&filter=device

<source lang="json">{
"result": [
{
"Active": "true",
"Color": "",
"Date": "",
"Days": 128,
"DevName": "coffeeSwitch",
"DeviceRowID": 1014,
"IsThermostat": "false",
"Level": 100,
"MDay": 0,
"Month": 0,
"Occurence": 0,
"Randomness": "false",
"ScheduleDate": "2021-03-11 06:01:00",
"Time": "06:01",
"TimerCmd": 0,
"TimerID": 62,
"TimerType": 2,
"TimerTypeStr": "On Time",
"Type": "Device"
},
{
"Active": "true",
"Color": "",
"Date": "",

"TimerType": 2,
"TimerTypeStr": "On Time",
"Type": "Device"
}
],
"status": "OK",
"title": "Schedules"
}
</source>

==Get all schedules(timers) for one Device==

/json.htm?type=command&param=gettimers&idx=timerID

===Type returns===

*0: Before Sunrise
*1: After Sunrise
*2: On Time
*3: Before Sunset
*4: After Sunset
*5: Fixed Date/Time
*6: Odd Day Numbers
*7: Even Day Numbers
*8: Odd Week Numbers
*9: Even Week Numbers
*10: Monthly
*11: Monthly (Weekday)
*12: Yearly
*13: Yearly (Weekday)
*14: Before Sun at South
*15: After Sun at South
*16: Before Civil Twilight Start
*17: After Civil Twilight Start
*18: Before Civil Twilight End
*19: After Civil Twilight End
*20: Before Nautical Twilight Start
*21: After Nautical Twilight Start
*22: Before Nautical Twilight End
*23: After Nautical Twilight End
*24: Before Astronomical Twilight Start
*25: After Astronomical Twilight Start
*26: Before Astronomical Twilight End
*27: After Astronomical Twilight End

<source lang="json">{
"result" :
[
{
"Active" : "true",
"Cmd" : 0,
"Color" : "",
"Date" : "",
"Days" : 128,
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"Time" : "08:30",
"Type" : 23,
"idx" : "45"
}
],
"status" : "OK",
"title" : "Timers"
}
</source>

==Get all schedules(timers) for all Scenes==
/json.htm?type=command&param=getschedules&filter=scene

<source lang="json">{
"result" :
[
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Lights",
"DeviceRowID" : 6,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 07:01:00",
"Time" : "00:03",
"TimerCmd" : 1,
"TimerID" : 4,
"TimerType" : 0,
"TimerTypeStr" : "Before Sunrise",
"Type" : "Scene"
},
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Garden lights",
"DeviceRowID" : 6,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 09:00:00",
"Time" : "09:00",
"TimerCmd" : 1,
"TimerID" : 6,
"TimerType" : 2,
"TimerTypeStr" : "On Time",
"Type" : "Scene"
},
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Frontdoor",
"DeviceRowID" : 5,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 01:30:00",
"Time" : "01:30",
"TimerCmd" : 0,
"TimerID" : 2,
"TimerType" : 2,
"TimerTypeStr" : "On Time",
"Type" : "Scene"
}
],
"status" : "OK",
"title" : "Schedules"
}
</source>

==Get all schedules(timers) for one Scene==
/json.htm?type=command&param=getscenetimers&idx=sceneID

<source lang="json">{
"result": [{
"Active": "true",
"Cmd": 0,
"Date": "",
"Days": 128,
"Level": 100,
"MDay": 0,
"Month": 0,
"Occurence": 0,
"Randomness": "false",
"Time": "01:30",
"Type": 2,
"idx": "2"
}
],
"status": "OK",
"title": "SceneTimers"
}</source>

==Get all schedules(timers) for all Thermostats==

/json.htm?type=command&param=getschedules&filter=thermostat
<source lang="json">{
"status": "OK",
"title": "Schedules"
}</source>

==Get all schedules(timers) for one Thermostat==

/json.htm?type=command&param=getsetpointtimers&idx=timerID
<source lang="json">{
"status": "OK",
"title": "SetpointTimers"
}</source>

==Enable specific schedule(timer) for Devices==

/json.htm?type=command&param=enabletimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "EnableTimer"
}</source>

==Disable specific schedule(timer) for Devices==

/json.htm?type=command&param=disabletimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DisableTimer"
}</source>

==Delete a specific schedule(timer) for Devices==

/json.htm?type=command&param=deletetimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DeleteTimer"
}</source>

==Enable specific schedule(timer) for Thermostats==

/json.htm?type=command&param=enablesetpointtimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "EnableSetpointTimer"
}</source>

==Disable specific schedule(timer) for Thermostats==

/json.htm?type=command&param=disablesetpointtimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DisableSetpointTimer"
}</source>

==Delete a specific schedule(timer) for Thermostats==
/json.htm?type=command&param=deletesetpointtimer&idx=timerID

<source lang="json">{
"status": "OK",
"title": "DeleteSetpointTimer"
}</source>

==Update parameters for a specific schedule(timer) for Devices==
/json.htm?type=command&param=updatetimer&idx=timerID&active=true&timertype=3&hour=0&min=20&randomness=true&command=0&days=12345<nowiki></source></nowiki>

*idx = timerID
*active = true/false
*timertype - see Get all schedules(timers) for one Device for timerTypeDefinition
*hour = hour
*min = minute
*randomness = true/false
*command = On=0 / Off=1 (inverted logic)
*days = 1=Mon, 2=Tue, 3=Wed, 4=Thurs, 5=Fri, 6=Sat, 7=Sun

==Create a new schedule(timer) for an existing device==

/json.htm?type=command&param=addtimer&idx=DeviceRowID&active=true&timertype=2&hour=0&min=20&randomness=false&command=0&days=1234567

<source lang="json">{
"status": "OK",
"title": "AddTimer"
}</source>

*idx = DeviceRowID = index of your device (other commands use a timerID as idx but here we use DeviceRowID).
*active = true/false
*timertype - see Get all schedules(timers) for one Device for timerTypeDefinition
*hour = hour
*min = minute
*randomness = true/false
*command = On=0 / Off=1 (inverted logic)
*days = 1=Mon, 2=Tue, 3=Wed, 4=Thurs, 5=Fri, 6=Sat, 7=Sun

==Clear all schedules(timers) for a particular device==

/json.htm?type=command&param=cleartimers&idx=DeviceRowID

<source lang="json">{
"status": "OK",
"title": "ClearTimer"
}
</source>

*idx = DeviceRowID = index of your device (other commands use a timerID as idx but here we use DeviceRowID).

==Enable specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=enablescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "EnableSceneTimer"
}</source>

==Disable specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=disablescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "DisableSceneTimer"
}
</source>

==Delete a specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=deletescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "DeleteSceneTimer"
}
</source>

=Notifications=

==Get all notification types==

<code>/json.htm?type=command&param=getnotifications</code><source lang="json">{
"notifiers": [{
"description": "browser",
"name": "browser"
}, {
"description": "clickatell",
"name": "clickatell"
}, {
"description": "email",
"name": "email"
}, {
"description": "fcm",
"name": "fcm"
}, {
"description": "http",
"name": "http"
}, {
"description": "kodi",
"name": "kodi"
}, {
"description": "lms",
"name": "lms"
}, {
"description": "prowl",
"name": "prowl"
}, {
"description": "pushalot",
"name": "pushalot"
}, {
"description": "pushbullet",
"name": "pushbullet"
}, {
"description": "pushover",
"name": "pushover"
}, {
"description": "pushsafer",
"name": "pushsafer"
}, {
"description": "telegram",
"name": "telegram"
}
],
"status": "OK",
"title": "Notifications"
}</source>

==Get device notifications==

/json.htm?idx=<deviceIDX>&param=getnotificationtypes&type=command
 <source lang="json">{
"result":
[
{
"ptag": "S",
"text": "Switch On",
"val": 7
}
],
"status": "OK",
"title": "GetNotificationTypes"
}</source>

<code>/json.htm?type=command&param=getnotifications&idx=<deviceIDX></code><source lang="json">{
"notifiers": [{
"description": "browser",
"name": "browser"
}, {
"description": "clickatell",
"name": "clickatell"
}, {
"description": "email",
"name": "email"
}, {
"description": "fcm",
"name": "fcm"
}, {
"description": "http",
"name": "http"
}, {
"description": "kodi",
"name": "kodi"
}, {
"description": "lms",
"name": "lms"
}, {
"description": "prowl",
"name": "prowl"
}, {
"description": "pushalot",
"name": "pushalot"
}, {
"description": "pushbullet",
"name": "pushbullet"
}, {
"description": "pushover",
"name": "pushover"
}, {
"description": "pushsafer",
"name": "pushsafer"
}, {
"description": "telegram",
"name": "telegram"
}
],
"result": [{
"ActiveSystems": "clickatell;email;fcm;http;kodi;lms;prowl;pushalot;pushbullet;pushover;pushsafer;telegram",
"CustomMessage": "test",
"Params": "S",
"Priority": 0,
"SendAlways": false,
"idx": 3
}
],
"status": "OK",
"title": "Notifications"
}</source>

==Add device notification==

/json.htm?idx=<deviceIDX>&param=addnotification&tmsg=test&tpriority=0&tsendalways=true&tsystems=fcm;http&ttype=7&tvalue=0&twhen=0&type=command

<source lang="json">{
"status": "OK",
"title": "AddNotification"
}</source>

==Update device notifications==

/json.htm?devidx=<DeviceID>&idx=<notificationID>&param=updatenotification&taction=<action command>&tactive=<true/false>&tmsg=<msgText>&tpriority=<pri>&tsendalways=<true/false>&tsystems=<list of notification subsystems>&ttype=<notificationType>&tvalue=0&twhen=0&type=command
<source lang="json">{
"status": "OK",
"title": "UpdateNotification"
}</source>

==Delete device notification==

json.htm?idx=<notificationID>&param=deletenotification&type=command

<source lang="json">{
"status": "OK",
"title": "DeleteNotification"
}</source>

==Delete all device notifications==

/json.htm?idx=<deviceID>&param=clearnotifications&type=command&idx=nnn
<source lang="json">{
"status": "OK",
"title": "ClearNotification"
}</source>

=LMS and Kodi (Media Players)=
While both Logitech Media Server and Kodi can be controlled by JSON RPC commands sent directly to the URL of the LMS server or Kodi instance, it can be useful to use Domoticz as a tunnel/proxy to send a number of widely-used commands because you may have an external port already open for Domoticz and because Domoticz also supports HTTPS.

==LMS==

<source lang="json">/json.htm?type=command&param=lmsmediacommand&idx=nnn&action=ACTION</source>

where ACTION can be: Left, Right, Up, Down, Favorites, Browse, NowPlaying, Shuffle, Repeat, Play, Pause, Stop, Rewind, Forward, Mute, VolumeUp, VolumeDown, PowerOn and PowerOff.

==Kodi==

<source lang="json">/json.htm?type=command&param=kodimediacommand&idx=nnn&action=ACTION</source>

where ACTION can be: PlayPause, Stop, FastForward, BigStepForward, Rewind, BigStepBack, ShowSubtitles, FullScreen, VolumeUp, VolumeDown, ChannelUp, ChannelDown, Channels
Home, Back, ContextMenu, Info, Select, Down, Right, Up, Left

=Evohome=

These commands work regardless of which of the 3 implementation-modes for Evohome you have chosen for your system (WebAPI, USB device, Scripting). Some of them will also work for e.g. the Honeywell Round WiFi thermostat.

==Updating the evohome controller mode==

<source lang="json"> /json.htm?type=command&param=switchmodal&idx=<idx>&status=<status>&action=<action>&ooc=<ooc></source>

*'''<idx>''' id number of the evohome controller device in Domoticz
*'''<status>''' Auto, AutoWithReset, AutoWithEco, Away, DayOff, Custom, HeatingOff
*'''<action>''' (1 = run on action script, 0 = disable)
*'''<ooc>''' (1 = only trigger the event & log on change, 0 = always trigger & log)

===Specify an until date===

<source lang="json"> /json.htm?type=command&param=switchmodal&idx=<idx>&status=<status>&action=<action>&ooc=<ooc>&until=<until></source>

*as above
*'''<until>''' ISO date time to run until. Format example ''2018-09-15T15:53:00'' or ''2018-09-15T15:53:00+01:00'' with timezone.

Note: most controller modes do not support the ''time'' part of the ISO data and will only act upon the ''date'' portion - this will require at least the next day to be reflected in the date number to successfully trigger an update.

==Updating a zone setpoint==

<code>/json.htm?type=command&param=setsetpoint&idx=<idx>&setpoint=<setpoint>&mode=<mode>&used=true</code>

*'''<idx>''' id number of the relevant evohome zone device in Domoticz
*'''<setpoint>''' set point in degrees (will be ignored for Auto)
*'''<mode>''' Auto, TemporaryOverride, PermanentOverride, FollowSchedule
*'''used''' must be true

===Specifying a date/time for zone TemporaryOverride===

<code>/json.htm?type=command&param=setsetpoint&idx=<idx>&setpoint=<setpoint>&mode=TemporaryOverride&until=<until>&used=true</code>

*as above
*'''<until>''' ISO date time for the set point override. Format example ''2018-09-15T15:53:00'' or ''2018-09-15T15:53:00+01:00'' with timezone.

In this case, any combination of a date portion and a time portion that are in the future will meet with success.

==Turning HotWater ON/OFF==

<code>/json.htm?type=command&param=setused&idx=<idx>&setpoint=<setpoint>&state=<state>&mode=<mode>&used=true</code>

*'''<idx>''' id number of the evohome DHW temp device in Domoticz
*'''<setpoint>''' set point in degrees (will be ignored)
*'''<state>''' On, Off
*'''<mode>''' Auto, TemporaryOverride, PermanentOverride, FollowSchedule
*'''used''' must be true

=Configuring zwave devices=
Below mentioned commands are for the to be deprecated OpenZwave integration. Switch to [[Zwave-JS-UI]] as soon as possible!! 
==Listing zwave node parameters==
<source lang="json"> json.htm?type=command&param=getopenzwavenodes&idx=ControllerIDX</source>

*ControllerIDX = the idx of your OpenZWave USB controller device, as listed under the 'Setup --> Hardware' tab.

Example output:

<source lang="json">
{
"NodesQueried" : true,
"ownNodeId" : 1,
"result" : [
{
"Description" : "Neo CoolCam Door/Window Detector",
"HaveUserCodes" : false,
"HomeID" : 3554707869,
"IsPlus" : true,
"LastUpdate" : "2018-08-04 20:09:02",
"Manufacturer_id" : "0x0258",
"Manufacturer_name" : "Neo CoolCam",
"Name" : "Garage DOor",
"NodeID" : 40,
"PollEnabled" : "false",
"Product_id" : "0x1082",
"Product_name" : "Door/Window Detector",
"Product_type" : "0x0003",
"State" : "Sleeping",
"Version" : 4,
"config" : [
{
"LastUpdate" : "2018-08-01 09:06:45",
"help" : "This configuration parameter that can be used to adjust the amount of delay before the OFF command is transmitted. This parameter can be configured with the value of 0 through 65535, where 0 means send OFF command immediately and 65535 means 65535 seconds of delay.",
"index" : 1,
"label" : "Configuring the OFF Delay",
"type" : "short",
"units" : "second",
"value" : "0"
},
{
"LastUpdate" : "2018-08-01 09:06:45",
"help" : "Basic Set Command will be sent where contains a value when the door/window is opened or closed, the receiver will take it for consideration; for instance, if a lamp module is received the Basic Set Command of which value is decisive as to how bright of dim level of lamp module shall be.",
"index" : 2,
"label" : "Basic Set Level",
"type" : "byte",
"units" : "",
"value" : "255"
},
{
"LastUpdate" : "2018-08-03 07:55:52",
"help" : "",
"index" : 2000,
"label" : "Wake-up Interval",
"type" : "int",
"units" : "Seconds",
"value" : "43200"
}
],
"idx" : "11"
},
{
"Description" : "FIBARO System FGWPE/F Wall Plug",
"HaveUserCodes" : false,
"HomeID" : 3554707869,
"IsPlus" : false,
"LastUpdate" : "2018-08-05 12:12:24",
"Manufacturer_id" : "0x010f",
"Manufacturer_name" : "FIBARO System",
"Name" : "Studio",
"NodeID" : 5,
.
.
.

</source>

Note the ''node_idx'' towards the end of each device's entry (the "idx" : "11" in the example above for the Neo CoolCam Door/Window Detector). You don't see this node_idx in the regular devices tab for Domoticz, but it is the idx you'll need when changing a parameter through JSON (next section).

==Getting the battery levels==
<source lang="json"> /json.htm?type=command&param=zwavegetbatterylevels&idx=controlleridx</source>

*controlleridx = the idx of your OpenZWave USB controller device, as listed under the 'Setup --> Hardware' tab.

Example output:

<source lang="json">
{
"result" : [
{
"battery" : 255,
"nodeID" : 17,
"nodeName" : "Designlamp bij TV"
},
{
"battery" : 255,
"nodeID" : 19,
"nodeName" : "Lichtknopje voorkamer"
},
{
"battery" : 100,
"nodeID" : 33,
"nodeName" : "Rookmelder"
}
],
"status" : "OK",
"title" : "GetBatteryLevels"
}</source>

Note: a Battery level of 255 indicates either a non battery powered device, or a battery powered device which has not yet send a battery measurement to OpenZWave yet.

==Changing a zwave device parameter==
<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=node_idx&valuelist=plist</source>

*node_idx = the value found by searching through the output of ''openzwavenodes'' for the node in question (see above)
*plist = the (partially) URI encoded and BASE64 encoded parameter list

The ''plist'' entries start with an unencoded decimal item number preceded by and followed by an underscore (e.g. _7_), followed by the correctly-encoded string. You can check out the encodings at the following links: [https://www.base64decode.org base64decode] and at [https://www.urlencoder.org urlencode]. In Base64, 'Enable' is written as 'RW5hYmxl', so it looks odd but it's easy once you grasp it.

For example, if you are configuring a NEO Coolcam Siren through JSON,

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=7_QWxhcm0gbXVzaWM%3D</source>

would change parameter 7 (Configure Default Siren On Mode) to 'Alarm music', while

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=7_RG9vciBiZWxsIG11c2lj%3D</source>

would change it to 'Door bell music' (because 'RG9vciBiZWxsIG11c2lj' is the result of Base64 encoding 'Door bell music'). Note: Any '%3D' and such in the ''plist'' are the result of URI encoding an '=' or other non-alphanumeric character.

The easiest way to learn about this is to change a zwave device parameter manually using your browser while you have '''developer tools''' enabled (hit 'ctrl-shift-i' in Chrome). Look under the ''network'' tab at the JSON sent back by the browser to Domoticz when you click on 'Apply Configuration for This Device'.

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=3_MjU1_1_SGlnaA%3D%3D_
2_MSBtaW51dGU%3D_4_TG93_5_MTA%3D_6_MQ%3D%3D_7_QWxhcm0gbXVzaWM%3D_8_RW5hYmxl_9_RGlzYWJsZQ%3D%3D_</source>

The browser will actually send the full parameter list to Domoticz, including the unchanged values of any parameters you didn't alter. If you modify one of them, however, you'll see that edit reflected in the Base64-encoded JSON string.

[[File:Screenshotjsondebug.png]]

=Language-specific JSON examples=
The following tiny code snippets demonstrate the syntax for using JSON with Domoticz from some popular programming languages.

==Bash==
A bash script to query the json result of a temperature device and print the temperature value <source lang="bash">
#!/bin/bash
curl -s 'http://192.168.178.12:8080/json.htm?type=devices&rid=104' | jq .result[0].Temp | sed 's/\"//g' | awk '{ print $1 }'
</source>

A simple bash script can be used to get the device status, by executing for example:<syntaxhighlight lang="bash">
#!/bin/bash
DOMOTICZ_URL="http://localhost:8080"
DEVICE_IDX=1209

status=`curl -s "${DOMOTICZ_URL}/json.htm?type=command&param=getdevices&rid=${DEVICE_IDX}" | jq '.result[0].Data' |tr -d \"`
#status variable assumes value Off or On, in case of light device.
if [ "a${status}" == "aOff" ]; then
# device status is Off
# ...
else
# device status is On
# ...
fi
</syntaxhighlight>

==PHP==
<source lang="php">
#!/usr/bin/php

<?php
$json_string = file_get_contents("http://192.168.178.12:8080/json.htm?type=devices&rid=110");
$parsed_json = json_decode($json_string, true);
$test_link = "/home/pi/output.txt";
$test_data = fopen ($test_link, "w+");
fwrite ($test_data, print_R($parsed_json, TRUE));
fclose ($test_data);
?>

</source>

==Python==
<source lang="python">
#!/usr/bin/python

import urllib
import urllib2
import requests

...

url = 'http://192.168.178.12:8080/json.htm?type=command&param=udevice&nvalue=0&idx='+idx+'&svalue='+sval
try:
request = urllib2.Request(url)
response = urllib2.urlopen(request)
except urllib2.HTTPError, e:
print e.code; time.sleep(60)
except urllib2.URLError, e:
print e.args; time.sleep(60)
</source>

==Perl==
<source lang="perl">

#!/usr/bin/perl

use LWP::UserAgent;
use JSON::XS;

$url{domo}=>'http://192.168.178.12:8080';
$idx=301;

$ua=LWP::UserAgent->new; $ua->timeout(5);
$retrieve=$ua->get($url{domo}.'/json.htm?type=devices&rid='.$idx);
$res=$retrieve->decoded_content;
if ($retrieve->is_success) { $jres = JSON::XS->new->allow_nonref->decode($res) } else { warn $retrieve->status_line };
$state=$$jres{result}[0]->{Status}; # 'On', 'Off', 'Open', 'Closed', etc
print "The switch state for idx $idx is currently '$state'\n";

</source>

Domoticz API/JSON URL's

2026-06-26T06:44:41Z

Walter vl: /* Counter */

Domoticz allows you to interact with all your switches and sensors using JSON, either interactively through a browser or programmatically from a scripting language. In fact, when you interact with the Domoticz UI through your browser by clicking on buttons and such, under the hood it's JSON that actually communicates your changes back to the Domoticz engine (Hint: You can watch this behaviour at any time by enabling '''developer tools''' in your browser and watching the ''network'' tab's traffic when you change something through the UI. See the section on ''changing a zwave device parameter'' for an example, with screenshot). This wiki describes how to use this versatile API. 

==Warning Stable 2023.2 (and newer)==
For users using API calls from outside Domoticz there has been some changes in API calls. They now always should be of the form <code>/json.htm?type=command&param=**command**</code>

For example

<code>/json.htm?type=graph</code> will be <code>/json.htm?type=command&param=graph</code>

<code>/json.htm?type=devices</code> will be <code>/json.htm?type=command&param=getdevices</code>

More info in Forum topic https://forum.domoticz.com/viewtopic.php?p=303581#p303581

<s>The following old RType commands will keep working but will give a deprecation warning eg</s>

<code><s>[WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command! (IP nnn.nnn.nnn.nnn)</s></code>

'''''Warning: in Domoticz stable 2025.1 these old RType API calls are really removed and instead of a warning you will get an error (404 - not found)!!'''''

'''/json.htm?type=**old command** -> /json.htm?type=command&param=**new command**'''
*"settings" -> "getsettings"
*"users" -> "getusers";
*"devices" -> "getdevices"
*"hardware" -> "gethardware";
*<s>"events" -> "events"</s>
*"notifications" -> "getnotifications"
*"createdevice" -> "createdevice"
*"scenes" -> "getscenes";
*"plans" -> "getplans"
*"graph" -> "graph"
*"scenelog" -> "getscenelog"
*"mobiles" -> "getmobiles"
*"cameras"-> "getcameras"
*"cameras_user" -> "getcameras_user"
*"schedules" -> "getschedules"
*"timers" -> "gettimers"
*"scenetimers" -> "getscenetimers"
*"setpointtimers" -> "getsetpointtimers"
*"plans" -> "getplans"
*"floorplans" -> "getfloorplans"
*"lightlog" -> "getlightlog"
*"textlog" -> "gettextlog"
*"setused" -> "setused"

The following old RType command has no fallback:

*"/json.htm?type=events"

The updated syntax is "''/json.htm?type=command&param=events&'''evparam=<eventsparam>'''''"

=Format=

<nowiki>http://<username:password@>domoticz-ip<:port>/json.htm?api-call</nowiki>

*<username:password@> = the username and password to access Domoticz, this is optional, see the [[Security]] page for details setting up login.
*domoticz-ip = the IP-address or hostname of your Domoticz installation.
*<:port> = the port number of your Domoticz installation, this is optional.

eg. http://192.168.1.2:8080/json.htm?type=command&param=udevice&idx=$idx&nvalue=0&svalue=79

Hint: You can have a look at the database for the nValue/sValue, or the .cpp code. 
==Making output more readable==
By default, most browser will display the JSON-output in a unordered mess, but some (like FireFox) will recognize it is JSON and show it in a readable manner. To make it more readable you could use a browser plugin that formats the JSON to a more human-readable layout. 
For Google Chrome you could use [https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc JSONView (Chrome web store)]. For other browsers a similar extension will probably exist. Look in the extensions/add-on store of your browser.

There are online sites which helps to do the same like https://jsonformatter.org. This site helps to format, tree view and validate JSON.

==Authorization==
When using some method other than a browser to connect to Domoticz it may be necessary to do Authorization differently.
Authorization over HTTP is done by setting the "Authorization" HTTP request header when sending the request to Domoticz. The value of this header is a base64 encoded string of the username and password. When connecting to Domoticz using a browser and the URL method above the browser sets the appropriate header. When creating your own app or script this is not always done for you.

*First the username and password are combined into one string "username:password"
*This string is encoded using the RFC2045-MIME version of base64
*The authorization method and a space i.e. "Basic " is then put before the encoded string.

This results in a header in the following format:
<source lang="json">Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</source>

How the header is send differs per programming language. Check the documentation of the language of your choice on how to set http request headers.

==Users==
When you use an user and password in this api, the user must have "user" or "admin" rights. See also page [[User Management]] 
The user also must have the right to access the device (see 'Set Devices' in Edit Users page).

==Base64 encode==
To encode a string using base64 you could use : [https://codebeautify.org/base64-encode codebeautify.org/base64-encode]

==Response==
All responses include a status which is either '''OK''' on success or '''ERR''' on failure
<source lang="json">{
"status" : "OK"
}</source>

=General usage=

Please note that many characters are not permitted in URL strings, including spaces, brackets, etc. Depending on which options below you are using, it may be necessary to '''URL encode''' the string first. This is also called URI-encoding, escaping or percent-encoding. See [https://www.url-encode-decode.com URL encode/decode].

As an example, the string:

This is a test ! (Really)

when properly encoded, looks like this

This%20is%20a%20test%20%21%20%28Really%29

It's also allowable to use a '+' instead of '%20' to encode spaces (this is normally reserved for HTML forms processing but Domoticz accepts both).

==A note on IDXes==
There are different categories of IDX values, such as for devices, for scenes, for timers, for hardware devices, etc. Make sure that you are using the correct IDX value when trying the commands below. Device IDXes can be found by looking at the ''Setup --> Devices'' tab in the UI. Similarly, ''Setup --> Hardware'' will list the hardware category IDXes. See the section(s) on ''scenes'' and ''timers/schedules'' below to see how to retrieve their particular IDXes or timerIDs using JSON.

==Retrieve status of Domoticz instance==

You can get the status of a Domoticz instance with:

/json.htm?type=command&param=getversion
<source lang="json">{
"DomoticzUpdateURL": "http://www.domoticz.com/download.php?channel=beta&type=release&system=linux&machine=armv7l",
"HaveUpdate": false,
"Revision": 9540,
"SystemName": "linux",
"UseUpdate": true,
"build_time": "2018-05-29 14:27:24",
"dzvents_version": "2.4.6",
"hash": "30295913",
"python_version": "3.5.3 (default, Jan 19 2017, 14:11:04) \n[GCC 6.3.0 20170124]",
"status": "OK",
"title": "GetVersion",
"version": "3.9530"
}</source>

'''From Stable 2023.2''' (7-jun-2023) when a request is done without any authorisation, only the following is returned:
<code>{
"status" : "OK",
"title" : "GetVersion"
}</code>
When requested by a (non-admin) User, it gives (''which is the current default response for users''):
<code>{
"HaveUpdate" : false,
"UseUpdate" : false,
"build_time" : "2023-06-04 16:08:09",
"dzvents_version" : "3.1.8",
"hash" : "98a7d1eef-modified",
<nowiki> "python_version" : "3.8.10 (default, Nov 14 2022, 12:59:47) \n[GCC 9.4.0]",</nowiki>
"status" : "OK",
"title" : "GetVersion",
"version" : "2023.1 (build 15331)"
}</code>
And for admins
<code>{
"DomoticzUpdateURL" : "<nowiki>https://www.domoticz.com/download.php?channel=stable&type=release&system=linux&machine=x86_64</nowiki>",
"HaveUpdate" : false,
"Revision" : 15091,
"SystemName" : "linux",
"UseUpdate" : true,
"build_time" : "2023-06-04 16:08:09",
"dzvents_version" : "3.1.8",
"hash" : "98a7d1eef-modified",
<nowiki> "python_version" : "3.8.10 (default, Nov 14 2022, 12:59:47) \n[GCC 9.4.0]",</nowiki>
"status" : "OK",
"title" : "GetVersion",
"version" : "2023.1 (build 15331)"
}</code>
 
==Get list of all defined users in the system==

<code>/json.htm?type=command&param=getusers</code>

<source lang="json">{
"result": [
{
"Enabled": "true",
"Password": "abcdef1234567890abcdef1234567889",
"RemoteSharing": 1,
"Rights": 2,
"TabsEnabled": 127,
"Username": "waaren",
"idx": "2"
},
{
"Enabled": "true",
"Password": "abcdef1234567890abcdef1234567889",
"RemoteSharing": 0,
"Rights": 2,
"TabsEnabled": 0,
"Username": "IFTTTx",
"idx": "3"
},
],
"status": "OK",
"title": "Users"
}</source>

==Get settings==

<code>/json.htm?type=command&param=getsettings</code>

This will return the settings defined in "Setup" under a JSON form.
For ex. :
<source lang="json">{
"AcceptNewHardware" : 0,
"ActiveTimerPlan" : 0,
"ClickatellEnabled" : "",
"ClickatellFrom" : "",
"ClickatellPassword" : "",
...
}</source>

==Retrieve Domoticz logfile information==

You can get the last couple (fixed at max. 100) of logmessages with:

/json.htm?type=command&param=getlog&lastlogtime=LASTLOGTIME&loglevel=LOGLEVEL

*

LOGLEVEL 1 = normal
2 = status
4 = error
268435455 = all

LASTLOGTIME starting with logmessages in LASTLOGTIME seconds since last epoch ( 0 = all available)

<source lang="json">{
"LastLogTime": "1615579727",
"result": [
{
"level": 4,
"message": "2021-03-12 17:11:47.613 Error: BuienRadar: Problem Connecting to Buienradar! (Check your Internet Connection!)"
},
{
"level": 4,
"message": "2021-03-12 18:30:05.598 Error: dzVents: Error: (3.1.6) openUV: /opt/domoticz/scripts/dzVents/scripts/openUV.lua:63: attempt to index a nil value (field 'result')"
},
{
"level": 4,
"message": "2021-03-12 21:08:47.542 Error: (Evohome) status request failed with message: Timeout was reached"
}
],
"status": "OK",
"title": "GetLog"
}</source>

==Add a log message to the Domoticz log==

You can add a log message to the system with:

/json.htm?type=command&param=addlogmessage&message=MESSAGE&level=LEVEL

*MESSAGE = a string you want to log. Make sure to URL-encode any unsafe non-alphanumeric characters. See [https://www.url-encode-decode.com URL encode/decode]

"LEVEL" 1 = normal // default
2 = status
4 = error

<source lang="json">{
"status": "OK",
"title": "AddLogMessage"
}</source>

==Retrieve status of specific device==

You can get the status of a device with:

/json.htm?type=command&param=getdevices&rid=IDX

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*or IDX = 10,20,30 (for querying a range devices, in this case devices with IDX 10, 20 and 30)

<source lang="json">{
"ActTime": 1613058183,
"AstrTwilightEnd": "19:39",
"AstrTwilightStart": "06:06",
"CivTwilightEnd": "18:20",
"CivTwilightStart": "07:24",
"DayLength": "09:46",
"NautTwilightEnd": "19:00",
"NautTwilightStart": "06:45",
"ServerTime": "2021-02-11 16:43:03",
"SunAtSouth": "12:52",
"Sunrise": "08:00",
"Sunset": "17:45",
"app_version": "2020.2 (build 12936)",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
"AddjValue2": 0,
"BatteryLevel": 255,
"CustomImage": 0,
"Data": "On",
"Description": "Plain text",
"DimmerType": "none",
"Favorite": 0,
"HardwareDisabled": false,
"HardwareID": 3,
"HardwareName": "virtual",
"HardwareType": "Dummy (Does nothing, use for virtual switches only)",
"HardwareTypeVal": 15,
"HaveDimmer": true,
"HaveGroupCmd": true,
"HaveTimeout": false,
"ID": "00014052",
"Image": "Light",
"IsSubDevice": false,
"LastUpdate": "2021-02-10 22:47:03",
"Level": 0,
"LevelInt": 0,
"MaxDimLevel": 100,
"Name": "mySwitch",
"Notifications": "false",
"PlanID": "0",
"PlanIDs": [
0
],
"Protected": false,
"ShowNotifications": true,
"SignalLevel": "-",
"Status": "On",
"StrParam1": "",
"StrParam2": "",
"SubType": "Switch",
"SwitchType": "On/Off",
"SwitchTypeVal": 0,
"Timers": "false",
"Type": "Light/Switch",
"TypeImg": "lightbulb",
"Unit": 1,
"Used": 1,
"UsedByCamera": false,
"User": "Admin (IP: 192.168.192.41)",
"XOffset": "0",
"YOffset": "0",
"idx": "2"
}
],
"status": "OK",
"title": "Devices"
}</source>

*The array result[0] contains a hash/dict with name/value pairs of settings that are relevant to the device in question, in this example a thermostat.
*Please note that it will be something like json.result[1] in classic Lua and dzVents script because in Lua an array starts with 1.

==Retrieve name / idx of all devices==

If you are not sure of the IDX and want to do a quick lookup of name/value pairs to match a device name to its IDX, use

/json.htm?type=command&param=devices_list

which will result in something like (fragment)

<source lang="json">
{
"name" : "Corner Light",
"value" : "156"
},
{
"name" : "Table Light",
"value" : "198"
},
</source>

==Get status of all devices of a certain type==

<code>/json.htm?type=command&param=getdevices&filter=all&used=true&order=Name</code>

This will return information about all used devices. If you want to retrieve information for a specific devicetype, you can use the following filters with &filter=:

light
weather
temp
utility
wind
rain
uv
baro
zwavealarms

<source lang="json">{
"ActTime": 1615581479,
"AstrTwilightEnd": "20:34",
"AstrTwilightStart": "05:09",
"CivTwilightEnd": "19:15",
"CivTwilightStart": "06:29",
"DayLength": "11:39",
"NautTwilightEnd": "19:54",
"NautTwilightStart": "05:50",
"ServerTime": "2021-03-12 21:37:59",
"SunAtSouth": "12:52",
"Sunrise": "07:02",
"Sunset": "18:41",
"app_version": "2020.2 (build 13065)",
"result": [
{
"List of all devices": 1
}
],
"status": "OK",
"title": "Devices"
}</source>

==Get status of all devices, including hidden ones==

<code>/json.htm?type=command&param=getdevices&used=true&displayhidden=1</code>

Device names starting with a '$' sign are invisible in both the ''Dashboard'' and ''Switches'' tabs in the Domoticz UI. If you want these devices included in the json output then ''displayhidden'' must be specified.

<source lang="json">{
"ActTime": 1615641865,
"AstrTwilightEnd": "20:36",
"AstrTwilightStart": "05:07",
"CivTwilightEnd": "19:16",
"CivTwilightStart": "06:26",
"DayLength": "11:43",
"NautTwilightEnd": "19:56",
"NautTwilightStart": "05:47",
"ServerTime": "2021-03-13 14:24:25",
"SunAtSouth": "12:51",
"Sunrise": "07:00",
"Sunset": "18:43",
"app_version": "2020.2 (build 13065)",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
...
"Name": "$Harmony_Mediacenter",
"Notifications": "false",
"PlanID": "0",
...
"YOffset": "0",
"idx": "2176"
},
],
"status": "OK",
"title": "Devices"
}
</source>

==Get status of all Favorite devices==

<code>/json.htm?type=command&param=getdevices&used=true&filter=all&favorite=1</code>

This will return only devices that are tagged as Favorite.
==Get server time==

/json.htm?type=command&param=getServerTime

<source lang="json">{
"ServerTime": "2021-01-13 23:10:13",
"status": "OK",
"title": "getServerTime"
}</source>

==Get sunrise and sunset times==

/json.htm?type=command&param=getSunRiseSet

<source lang="json">{
"ServerTime" : "Sep 30 2013 17:15:21",
"Sunrise" : "07:38:00",
"Sunset" : "19:16:00",
"status" : "OK",
"title" : "getSunRiseSet"
}</source>

==Use Notification Subsystem==

You can post a notification to all enabled notification systems with:

/json.htm?type=command&param=sendnotification&subject=SUBJECT&body=THEBODY

<source lang="json">{
"status": "OK",
"title": "SendNotification"
}</source>

You can also post a notification to one or more notification systems with:

/json.htm?type=command&param=sendnotification&subject=SUBJECT&body=THEBODY&subsystem=SUBSYSTEM1;SUBSYSTEM2;...&extradata=EXTRADATA1;EXTRADATA2;....

*SUBJECT = a string you want to use as subject
*THEBODY= a string you want to use as body
*SUBSYSTEM= the notification system(s) you want to use (lowercase)
*EXTRADATA=Some subsystems can have extra data like for example FCM can have the specigic devices to be notified eg extradata=midx_7

Subsystems:
fcm
http
kodi
lms
nma
prowl
pushalot
pushbullet
pushover
pushsafer

==Backup and database related==

send a VACUUM request to domoticz database; sqlite.org: "The VACUUM command rebuilds the database file, repacking it into a minimal amount of disk space "

Please note that this command does require free space on the used temporary file system up to twice the current databases size.

See [[https://sqlite.org/tempfiles.html sqlite.org] ] goto ''' 5.Temporary File Storage Locations '''

<source lang="http">json.htm?type=command&param=vacuumdatabase</source>
<source lang="json">
{
"status": "OK",
"title": "VacuumDatabase"
}
</source>

<source lang="http">/backupdatabase.php</source>

this call will create a database backup in the download directory of your workstation.

==Event system==

Get overview of (internal) events

From Stable 2023.2: <code>/json.htm?type=command&param=events&evparam=list</code>

Deprecated format (no fallback possible!) <code><s>/json.htm?type=events&param=list</s></code><source lang="json">
{
"interpreters": "Blockly:Lua:dzVents:Python",
"result": [
{
"eventstatus": "0",
"id": "77",
"name": "Lua pinger"
},
{
"eventstatus": "0",
"id": "106",
"name": "Lua curl"
},
....
}
],
"status": "OK",
"title": "ListEvents"
}
</source>
Deprecated format (no fallback possible!) <code><s>/json.htm?type=events&param=updatestatus&eventid=77&eventstatus=1</s></code>

From Stable 2023.2: <code>/json.htm?type=command&param=events&evparam=updatestatus&eventid=77&eventstatus=1</code><source lang="json">
{
"status": "OK",
"title": "Events"
}
</source>

==Accept new sensors==

<source lang="http">/json.htm?type=command&param=allownewhardware&timeout=MINUTES</source>

<source lang="json">
{
"status": "OK",
"title": "AllowNewHardware"
}
</source>

==Get list of custom icons==

<source lang="http">/json.htm?type=command&param=getcustomiconset</source>
Add 100 to the Idx value to use it in the [[Domoticz API/JSON URL's#change Icon Not available for all device types|set Custom icon command]].
So listed Idx: 2 is iconNumber 102 for the command.
<source lang="json">
{
"result": [
{
"Description": "OpenAQ",
"IconFile16": "images/xfr_openaq2.png",
"IconFile48Off": "images/xfr_openaq248_Off.png",
"IconFile48On": "images/xfr_openaq248_On.png",
"Title": "OpenAQ",
"idx": 1
},
{
"Description": "Omnik Logo",
"IconFile16": "images/Omnik.png",
"IconFile48Off": "images/Omnik48_Off.png",
"IconFile48On": "images/Omnik48_On.png",
"Title": "Omnik",
"idx": 2
}
],
"status": "OK",
"title": "GetCustomIconSet"
}
</source>

=Lights and switches=

==Get details of all lights/switches==

/json.htm?type=command&param=getlightswitches

OR

<code>/json.htm?type=command&param=getdevices&filter=light&used=true&order=Name</code>

Example output:
<source lang="json">

{
"result" : [
{
"IsDimmer" : false,
"Name" : "Bedroom lights",
"SubType" : "Energenie",
"Type" : "Lighting 1",
"idx" : "43"
},
{
"IsDimmer" : false,
"Name" : "Hall",
"SubType" : "Energenie",
"Type" : "Lighting 1",
"idx" : "30"
},
{
"IsDimmer" : true,
"Name" : "Lounge Light Front",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "32"
},
{
"IsDimmer" : true,
"Name" : "Lounge Lights All",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "66"
},
{
"IsDimmer" : true,
"Name" : "Lounge light back",
"SubType" : "RGBW",
"Type" : "Lighting Limitless/Applamp",
"idx" : "33"
}
],
"status" : "OK",
"title" : "GetLightSwitches"
}
</source>

==Turn a light/switch on/off==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=<On|Off|Toggle|Stop>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>
When error:
<source lang="json">{
"message" : "Error sending switch command, check device/hardware (idx=nnn) !",
"status" : "ERROR",
"title" : "SwitchLight"
}</source>
==Open-Close-Stop Blinds==

Open-Close Blinds

/json.htm?type=command&param=switchlight&idx=99&switchcmd=<Open|Close|Stop>

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Set%20Level&level=<0..100>

==General notes==

Commands are case sensitive!

Beware that if the switch has the 'protected' attribute set then you need add key `passcode` (with the right passcode)

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Off&passcode=YOUR_SWITCH_PASSWORD_AS_SET_IN_SETTINGS

or the status will be

<source lang="json">{
"message" : "WRONG CODE",
"status" : "ERROR",
"title" : "SwitchLight"
}</source>

Note that when you use '''&switchcmd''', the http:// or script:// on/off actions of the corresponding switch are executed. If you just want to update the status of the switch in Domoticz ''without'' running these actions, use the '''&param=udevice''' option instead (see update-section below).

==Switching RFY Blinds sun/wind detector on/off==

On some type of blinds it is possible to enable/disable the sun/wind detector.

Enable (where the number behind idx is the idx number of the screen in domoticz):
/json.htm?type=command&param=switchlight&idx=7&switchcmd=EnableSunWind
Disable:
/json.htm?type=command&param=switchlight&idx=7&switchcmd=DisableSunWind

==Set a dimmable light/selector to a certain level==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Set%20Level&level=6

*dimmable:
**Some lights have 100 dim levels (like zwave and others), other hardware (kaku/lightwaverf) have other ranges like 16/32
**Level should be the dim level (not percentage), like 0-16 or 0-100 depending on the hardware used
**When the light is off, it will be turned on
*Blinds: enter percentage, level will be 0-100
*Selector switch: enter the level number (eg 10, 20 or 30) that can be found in the edit section of a switch.
*To update in Domoticz only without running it's device actions use <code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=[0,1,2]&svalue=LEVELNR</code> Statuses for Blinds Percentage when using &param=udevice:

Closed: nValue = 1 and sValue = 100
partially opened: nValue = 2 and sValue = 1-99
Open: nValue = 0 and sValue = 0
<source lang="json">{
"status" : "OK",
"title" : "SwitchLight"
}</source>

==Set a light to a certain color or color temperature==

Color can be specified as either hue + brightness, RGB + optional brightness or a Domoticz JSON color object

;Specify hue and brightness
:Hue in degrees, 0..360
:Brightness 0..100

/json.htm?type=command&param=setcolbrightnessvalue&idx=99&hue=274&brightness=40&iswhite=false

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

:Note: There is no saturation parameter, specify RGB format Domoticz JSON color format for full color control

;Specify RGB and brightness (optional)
:RGB as hexadecimal number, RRGGBB without prefix (no 0x or #)

/json.htm?type=command&param=setcolbrightnessvalue&idx=99&hex=RRGGBB&brightness=100&iswhite=false

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

:Note: The actual brightness of the light is a combination of RGB value and brightness. Brightness parameter may be omitted.
:A site like [http://www.colorhexa.com/ff8c00 colorhexa] can be used to help pick hex values according to desired colours.

;Specify Domoticz JSON color object and brightness
:Example: Specify color mode with a dim blue color

/json.htm?type=command&param=setcolbrightnessvalue&idx=130&color={"m":3,"t":0,"r":0,"g":0,"b":50,"cw":0,"ww":0}&brightness=100

<source lang="json">{
"status": "OK",
"title": "SetColBrightnessValue"
}</source>

'''Domoticz color format:'''

Domoticz color format is used as:

*input parameter to:
*:- setcolbrightnessvalue
*:- updatetimer
*:- addtimer
*:- addscenedevice
*:- updatescenedevice
*In response from:
*:- devices
*:- getscenedevices
*:- timers

Example: <code>color={"m":3,"t":0,"r":0,"g":0,"b":50,"cw":0,"ww":0}</code>
<nowiki>
ColorMode {
ColorModeNone = 0, // Illegal
ColorModeWhite = 1, // White. Valid fields: none
ColorModeTemp = 2, // White with color temperature. Valid fields: t
ColorModeRGB = 3, // Color. Valid fields: r, g, b.
ColorModeCustom = 4, // Custom (color + white). Valid fields: r, g, b, cw, ww, depending on device capabilities
ColorModeLast = ColorModeCustom,
};

Color {
ColorMode m;
uint8_t t; // Range:0..255, Color temperature (warm / cold ratio, 0 is coldest, 255 is warmest)
uint8_t r; // Range:0..255, Red level
uint8_t g; // Range:0..255, Green level
uint8_t b; // Range:0..255, Blue level
uint8_t cw; // Range:0..255, Cold white level
uint8_t ww; // Range:0..255, Warm white level (also used as level for monochrome white)
}
</nowiki>

'''References'''
This API call is called internally by dzVents when using the following device object methods:

*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setColor(r, g, b, br, cw, ww, m, t)]
*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setColorBrightness()]

Please ensure local access is enabled for 127.0.0.1 or 127.0.0.*
[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#Using_dzVents_with_Domoticz (described here)].
for these to work correctly. 
The parameters r, g, b, cw, ww, m and t map to the same values in the aforementioned color object. 
The parameter br maps to brightness [0..100]. 

==Set an RGB_CW_WW or CW_WW light to a certain color temperature==

/json.htm?type=command&param=setkelvinlevel&idx=99&kelvin=1

<source lang="json">{
"status": "OK",
"title": "Set Kelvin Level"
}</source>
Range of kelvin parameter: 0..100, 0 is coldest, 100 is warmest

'''References'''
This API call is called internally by dzVents when using the following device object method:

*[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#RGBW.28W.29_.2F_Lighting_Limitless.2FApplamp setKelvin(Kelvin)]

Please ensure local access is enabled for 127.0.0.1 or 127.0.0.*
[https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting#Using_dzVents_with_Domoticz (described here)].
for this to work correctly. 

==Toggle a switch state between on/off==

/json.htm?type=command&param=switchlight&idx=99&switchcmd=Toggle

<source lang="json">{
"status" : "OK",
"title" : "SwitchLight"
}</source>

=Cameras=
==Get cameras==
<code>/json.htm?type=command&param=getcameras</code><source lang="json">
{
"result": [
{
"Address": "192.168.192.111",
"Enabled": "true",
"ImageURL": "image.jpg",
"Name": "Inside",
"Password": "Secret",
"Port": 19767,
"Protocol": 0,
"Username": "anyUser",
"idx": "1"
},
{
"Address": "192.168.192.112",
"Enabled": "true",
"ImageURL": "image.jpg",
"Name": "Outside",
"Password": "verySecret",
"Port": 19765,
"Protocol": 0,
"Username": "anotherUser",
"idx": "2"
}
],
"status": "OK",
"title": "Cameras"
}
</source>

==Add camera==

imageurl must be base64 encoded

<source lang="json">

/json.htm?type=command&param=addcamera&address=192.168.192.111&port=19765&name=insideCamera&enabled=true&imageurl=aW1hZ2UuanBn&protocol=0

{
"status": "OK",
"title": "AddCamera"
}

</source>

==Update camera==

imageurl must be base64 encoded

<source lang="json">

/json.htm?type=command&param=updatecamera&address=192.168.192.111&port=19767&name=test&enabled=true&idx=1&imageurl=aW1hZ2UuanBn&protocol=0

{
"status": "OK",
"title": "UpdateCamera"
}

</source>

==Send snapshot from camera==

imageurl must be base64 encoded

&user&password optional

Sends email with a camera snapshots if email is configured in Menu Setup - Settings and set for attachments.

camidx: Send 1 or multiple camerIDs in ; separated.

Subject: Subject of email

<source lang="json">

/json.htm?type=command&param=emailcamerasnapshot&camidx=1;3&subject=Movement+at+Frontdoor

{
"status": "OK",
"title": "Email Camera Snapshot"
}

</source>

=Scenes / Groups=
==Get current state of all scenes & groups==

<code>/json.htm?type=command&param=getscenes</code>

Example output:
<source lang="json">{
"result" : [
{
"Favorite" : 1,
"HardwareID" : 0,
"LastUpdate" : "2013-09-29 19:11:01",
"Name" : "My Scene",
"Status" : "Off",
"Timers" : "true",
"Type" : "Scene",
"idx" : "9"
},
{
"Favorite" : 1,
"HardwareID" : 0,
"LastUpdate" : "2013-09-30 11:49:13",
"Name" : "My Group",
"Status" : "Off",
"Timers" : "false",
"Type" : "Group",
"idx" : "3"
}
],
"status" : "OK",
"title" : "Scenes"
}</source>

==Turn a scene / group on or off==

/json.htm?type=command&param=switchscene&idx=&switchcmd=<On|Off|Toggle>

*idx = id of your scene/group.
*switchcmd = "On", "Off" or "Toggle" (case sensitive!)
*Scenes can only be turned '''On'''

<source lang="json">{
"status" : "OK",
"title" : "SwitchScene"
}</source>

==Add a scene (0)==
<code>/json.htm?type=command&param=addscene&name=''scenename''&scenetype=0</code>

==Add a group (1)==
<code>/json.htm?type=command&param=addscene&name=''scenename''&scenetype=1</code>

==Delete a scene or group==
<code>/json.htm?type=command&param=deletescene&idx=''number''</code>

==List devices in a scene==
/json.htm?type=command&param=getscenedevices&idx=''number''&isscene=true

==Add device to a scene==
/json.htm?type=command&param=addscenedevice&idx=''number''&isscene=true&devidx=''deviceindex''&command=1&level=''number''&hue=''number''

==Delete device from a scene==
/json.htm?type=command&param=deletescenedevice&idx=''number''

==List activation devices of a scene==
/json.htm?type=command&param=getsceneactivations&idx=''number''

Example output:
<source lang="json">{
"result": [
{
"code": 0,
"codestr": "-",
"idx": 249,
"name": "Activator device"
},
{
"code": 0,
"codestr": "-",
"idx": 1048,
"name": "Another Activator device"
}
],
"status": "OK",
"title": "GetSceneActivations"
}</source>

==Add activation devices for a scene==

<code>/json.htm?type=command&param=addscenecode&sceneidx=<scene ID>&idx=<device ID>&cmnd=<command></code>

Example output:
<source lang="json">
{
"status": "OK",
"title": "AddSceneCode"
}</source>

==Add OnAction and OffAction to a scene or group==
This command can be issue only after a scene or group was created, so first create the scene/group, than update the scene/group specifying the On Action and/or Off Action
<code>/json.htm?type=command&param=updatescene&idx=''number''&scenetype=''scenetype''&onaction=''base64onaction''&offaction=''base64offaction''</code>

where ''number'' is the idx of the scene/group, ''scenetype'' is 0 for scenes of 1 for groups, ''base64onactions'' is the On Action coded with base64 and ''base64offaction'' is the Off Action coded with base64. It's possible to find base64 converters online, like https://www.base64encode.org/

Please note that you have to include your current description if any

Example output:

<source lang="json">{
"status": "OK",
"title": "UpdateScene"
}</source>

==List timers of a scene==
<code>/json.htm?type=command&param=getscenetimers&idx=''number''</code>

Example output:
<source lang="json">{
"result" : [
{
"Active" : "true",
"Cmd" : 0,
"Date" : "07-02-2016",
"Days" : 128,
"Hue" : 0,
"Level" : 100,
"Randomness" : true,
"Time" : "00:01",
"Type" : 5,
"idx" : "16"
}
],
"status" : "OK",
"title" : "SceneTimers"
}</source>

==Add timer to a scene==

/json.htm?type=command&param=addscenetimer&idx=''number''&active=&timertype=&date=&hour=&min=&randomness=&command=&level=&days=

*idx = index of your scene/group.
*active = true/false
*timertype = 0 = Before Sunrise, 1 = After Sunrise, 2 = On Time, 3 = Before Sunset, 4 = After Sunset, 5 = Fixed Date/Time
*date = MM-DD-YYYY
*hour = hour
*min = minute
*randomness = true/false
*command = On/Off
*level = 0..100 (%)
*days = 0x80 = Everyday, 0x100 = Weekdays, 0x200 = Weekends, 0x01 = Mon, 0x02 = Tue, 0x04 = Wed, 0x08 = Thu, 0x10 = Fri, 0x20 = Sat, 0x40 = Sun

==Enable/disable/delete specific scene schedule(timer)==
[[Domoticz_API/JSON_URL's#Enable specific schedule(timer) for Scenes/Groups|Enable specific schedule(timer) for Scenes/Groups]]

[[Domoticz_API/JSON_URL's#Disable specific schedule(timer) for Scenes/Groups|Disable specific schedule(timer) for Scenes/Groups]]

[[Domoticz_API/JSON_URL's#Delete specific schedule(timer) for Scenes/Groups|Delete specific schedule(timer) for Scenes/Groups]]

=Setpoint/Thermostat control=

==Set Setpoint==
/json.htm?type=command&param=setsetpoint&idx=IDX&setpoint=SETPOINT

*IDX = id of the setpoint
*SETPOINT = value (for temperature in Celsius (like 20.5))

For '''Thermostat6''' devices, implemented in beta 2025.2, the following update additional update API calls are available:

== Update temp/hum/baro/setpoint ==
You cannot just set the temp/Hum/baro, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;HUM;HUM_STAT;BAR;BAR_FOR</code>

Barometer forecast does not seem to work....

* IDX = id of your device (This number can be found in the devices tab in the column "IDX")
* TEMP = Temperature
* HUM = Humidity
* HUM_STAT = Humidity status
* BAR = Barometric pressure
* BAR_FOR = Barometer forecast

HUM_STAT can be one of:

* 0=Normal
* 1=Comfortable
* 2=Dry
* 3=Wet

Barometer forecast of device type "General" (Virtual) can be one of:

0 = No Info

1 = Sunny

2 = Partly Cloudy

3 = Cloudy

4 = Rain

== Update temp/setpoint ==
You cannot just set the temp, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT</code>

See temp/hum/baro/setpoint for the applicable options.

== Update temp/hum/setpoint ==
You cannot just set the temp/Hum, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;HUM;HUM_STAT</code>

See temp/hum/baro/setpoint for the applicable options.

== Update temp/baro/setpoint ==
You cannot just set the temp/baro, you have to set everything including setpoint

<code>/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;SETPOINT;BAR;BAR_FOR</code>

Barometer forecast does not seem to work....

See temp/hum/baro/setpoint for the applicable options.

=Server control=

==Shutdown system==
/json.htm?type=command&param=system_shutdown

<source lang="json">{
"status" : "OK",
"title" : "SystemShutdown"
}</source>

==Reboot system==
/json.htm?type=command&param=system_reboot

<source lang="json">{
"status" : "OK",
"title" : "SystemReboot"
}</source>

=Create, delete, rename, action and disable commands=

==Create virtual hardware==
/json.htm?type=command&param=addhardware&htype=15&port=1&name=Sensors1&enabled=true

afterwards to get the id, either you have your last created id from an index you maintain or sort the hardware page for last ID:
<code>/json.htm?type=command&param=gethardware</code>

==Create a virtual sensor==

Basic action (see below for values)
<code>/json.htm?type=command&param=createvirtualsensor&idx=HWIDX&sensorname=SENSORNAME&sensortype=SENSORTYPE</code>

Note: It is normally easier to use the CreateDevice JSON (see next section)

Temp+Humidity example
/json.htm?type=<code>command&param=</code>createvirtualsensor&idx=HWIDX&sensorname=TempHum&sensortype=82
Electricity example
/json.htm?type=<code>command&param=c</code>reatevirtualsensor&idx=HWIDX&sensorname=Energy&sensortype=90

and then get the device id from the list:
/json.htm?type=<code>command&param=get</code>devices&filter=all&used=true&order=Name

Values:

*HWIDX = id of your (Dummy) hardware (not the device!). This number can be found in the hardware tab in the column "IDX".

Note: If a non existing hardware IDX is used the created device is greyed out in the user interface!

*SENSORNAME = sensor name
*SENSORTYPE = See list below (this is an incomplete list. For more devices see page [[Developing a Python plugin]])

1 Pressure (Bar) 0.0 nvalue=BAR (TBC)
2 Percentage 0.0 nvalue=PCT (TBC)
80 TEMP 0.0 svalue=TEMP
81 HUM 1 nvalue=HUM svalue=1 to 3
82 TEMP_HUM 0.0;50;1 svalue=TEMP;HUM;HUM_STATUS
84 TEMP_HUM_BARO 0.0;50;1;1010;1 svalue=TEMP;HUM;HUM_STATUS;BARO;BARO_FCST
85 RAIN 0;0 svalue=RAIN;Rain in mm/h
86 WIND 0;N;0;0;0;0 svalue=WIN_SPD;WIND_DIR;?;?;?;?
87 UV 0;0 svalue= (TBC)
113 RFXMeter 0 Can have several values, another order has to be sent to set the sub type:
type 5 Time: svalue=COUNTER
type 4 Energy generated: svalue=POWER;ENERGY
type 3 Counter: svalue=COUNTER
type 2 Water: svalue=VOLUME
type 1 Gas: svalue=VOLUME
type 0 Energy: svalue=POWER;ENERGY
90 ENERGY 0;0.0 svalue=POWER;ENERGY
249 TypeAirQuality 0 nvalue=PPM

For the RFXMeter another request is needed to set the utility (switchtype). URL is:
<code>/json.htm?type=command&param=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true</code>

where DEVICE_IDX is the device idx, SENSORNAME is device name, and the SUBTYPE_VALUE is one of:
0 for Energy
1 for Gas
2 for Water
3 for Custom Counter
4 for Energy Generated
5 for Time

==Create a device==
An overview of all available devices can be found in wiki page [[Developing_a_Python_plugin#Available_Device_Types]]

Basic Action:

<code>/json.htm?type=command&param=createdevice&idx=HWIDX&name=SENSORNAME&sensormappedtype=MAPPEDTYPE".</code>

*HWIDX = id of your (Dummy) hardware. This number can be found in the hardware tab in the column "IDX".

Note: If a non existing hardware IDX is used the created device is greyed out in the user interface!

*SENSORNAME = sensor name
*DEVICETYPE = type of device, see overview [[Developing_a_Python_plugin#Available_Device_Types]]

Source: https://github.com/domoticz/domoticz/blob/development/hardware/hardwaretypes.h or https://github.com/domoticz/domoticz/blob/development/main/RFXtrx.h

*DEVICESUBTYPE = subtype of device, see overview [[Developing_a_Python_plugin#Available_Device_Types]]

Source: https://github.com/domoticz/domoticz/blob/development/hardware/hardwaretypes.h or https://github.com/domoticz/domoticz/blob/development/main/RFXtrx.h

Example Result
<source lang="json">{
"idx" : "142",
"status" : "OK",
"title" : "CreateSensor"
}</source>

'''Examples:'''

Temp (Type: pTypeTEMP, subType: sTypeTEMP5)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Temp5&devicetype=50&devicesubtype=5
Voltage (Type: pTypeGeneral, subType: sTypeVoltage)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Voltage0&devicetype=243&devicesubtype=8
Electric (Instant+Counter)
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=ElecInstCount&devicetype=243&devicesubtype=29
Counter Incremental
/json.htm?type=<code>command&param=</code>createdevice&idx=HWIDX&sensorname=Counter%20Increment2&devicetype=243&devicesubtype=28

For the Counter Incremental, Counter and managed Counter and Switches another request is needed to set the type(switchtype). URL is:
/json.htm?type=<code>command&param=</code>setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true
where for counters DEVICE_IDX is the device idx, SENSORNAME is device name, and the SUBTYPE_VALUE is one of:
0 for Energy
1 for Gas
2 for Water
3 for Custom Counter
4 for Energy Generated
5 for Time

For switches
SubType Name
0 On/Off
1 Doorbell
2 Contact
3 Blinds
4 X10 Siren
5 Smoke Detector
6 Blinds Inverted
7 Dimmer
8 Motion Sensor
9 Push On Button
10 Push Off Button
11 Door Contact
12 Dusk Sensor
13 Blinds Percentage
14 Venetian Blinds US
15 Venetian Blinds EU
16 Blinds Percentage Inverted
17 Media Player
18 Selector
19 Door Lock
20 Door Lock Inverted
21 Blinds Percentage with Stop
22 Blinds Percentage with Stop Inverted

== List hardware ==
<code>/json.htm?type=command&param=gethardware</code>

==Rename hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<new name>&enabled=<true or false>&idx=<hardware idx>
 
To get the required data from the hardware first do
<code>/json.htm?type=command&param=gethardware</code> 

==Rename device / sensor==
<code>/json.htm?type=command&param=setused&idx=<device ID>&name=<new name>&used=true</code> 

==Enable hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<name>&enabled=true&port=<port name>&idx=<hardware idx>&loglevel=<log level>

'''note''' Use the complete set of parms that you find when entering the enable command on the GUI because if not completely entered it will destroy your hardware table. Test first on a test system !!

==Disable hardware==
/json.htm?type=command&param=updatehardware&htype=<type>&name=<name>&enabled=false&idx=<hardware idx>
To get the required data from the hardware first do
 
<code>/json.htm?type=command&param=gethardware</code>

 
'''note''' Use the complete set of parms that you find when entering the disable command on the GUI because if not completely entered it will remove data from the parms. Test on a test system first !!

==Delete hardware==
/json.htm?type=command&param=deletehardware&idx=<hardware idx>

<source lang="json">{
"status" : "OK",
"title" : "DeleteHardware"
}</source>

==Delete a device or sensor==
<code>/json.htm?type=command&param=setused&used=false&idx=<device idx></code><source lang="json">{
"status" : "OK",
"title" : "SetUsed"
}</source>

==Enable/Disable a device or sensor==
/json.htm?type=command&param=setdevused&idx=<device idx>&used=<true/false>&name=<device name>
(device name is a optional parameter)
<source lang="json">{
"status" : "OK",
"title" : "SetDeviceUsed"
}</source>

==Enable a disabled device or sensor==

/json.htm?idx=<device idx>&name=<new name>&type=setused&used=true
or
/json.htm?idx=<device idx>&type=setused&used=true

<source lang="json">{
"status" : "OK",
"title" : "SetUsed"
}</source>

==Add an On action and/or an Off action to a device or sensor==

/json.htm?type=setused&used=true&idx=IDX&strparam1=base64Encoded(ON ACTION STRING)&strparam2=base64Encoded(OFF ACTION STRING)

<source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

==Transfer device==

<code>/json.htm?type=command&param=dotransferdevice&idx=IDX_1&newidx=IDX_2</code>

Transfer sensor log of device with oldest lastUpdate value to device with most recent lastUpdate value. So not necessarily from IDX_1 to IDX_2 or the other way around.
Source device is removed after transfer of logs.

<source lang="json">{
"status": "OK",
"title": "TransferDevice"
}</source>

=Update devices/sensors=
Note that when you use this &param=udevice option with the additional option &parsetrigger=false, the device is updated ''without'' running the associated on/off- and script actions.

Expert usage. Directly set device parameters via JSON.
 

Be careful when firing values to domoticz.db as there is a chance to crash the database if parameters are wrong or missing.
First go to the devices tab and notice the device index (idx) of the device you want to change 

==Generic update API's==

Note make sure stringparms must be urlenecoded (eg. <space> %20, <Double quote> %27 etc..

===update a sensor device===
Note: for switches/lights/dimmers see Lights and Switches section.

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

===change Icon Not available for all device types===

<code>/json.htm?type=command&param=setused&used=true&name=<devicename>&description=<description>&idx=<idx>&switchtype=<switchType>&customimage=<iconNumber></code>

Use the [[Domoticz API/JSON URL's#Get list of custom icons|getcustomiconset command]] to get a list of all custom icons. Add 100 the given Idx value to set the iconnumber. So listed Idx:2 is iconNumber 102<source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

===change name===

/json.htm?type=command&param=renamedevice&name=<new devicename>&idx=<idx>

<source lang="json">{
"status": "OK",
"title": "RenameDevice"
}</source>

===protection On / Off===

<code>/json.htm?type=command&param=setused&used=true&protected=<true/falseidx=<idx></code><source lang="json">{
"status": "OK",
"title": "SetUsed"
}</source>

===update in domoticz only===

does not parse the actual command to the hardware (like MQTT)

with parsetrigger=false -->> No event is triggered either

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>&parsetrigger=<false/true>

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 

 
<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Humidity==
/json.htm?type=command&param=udevice&idx=IDX&nvalue=HUM&svalue=HUM_STAT

The above sets the parameters for a Humidity device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*HUM = Humidity: 45% 
*HUM_STAT = Humidity_status 

 
Humidity_status can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=BAR;BAR_FOR

The above sets the parameters for a Barometer device from hardware type 'General' 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 

 
Barometer forecast can be one of: 
0 = Stable 
1 = Sunny 
2 = Cloudy 
3 = Unstable 
4 = Thunderstorm 
5 = Unknown 
6 = Cloudy/Rain 

 

Barometer forecast of other device types can be one of: 
0 = Heavy Snow 
1 = Snow 
2 = Heavy Rain 
3 = Rain 
4 = Cloudy 
5 = Some Clouds 
6 = Sunny 
7 = Unknown 
8 = Unstable 
9 = Stable 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/humidity==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;HUM;HUM_STAT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*HUM = Humidity (0-100 %) 
*HUM_STAT = Humidity status 

 
HUM_STAT can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 
<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/humidity/barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;HUM;HUM_STAT;BAR;BAR_FOR

The above sets the parameters for a Temp+Humidity+Barometer device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*HUM = Humidity 
*HUM_STAT = Humidity status 
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 

 
HUM_STAT can be one of: 

*0=Normal 
*1=Comfortable 
*2=Dry 
*3=Wet 

 
Barometer forecast of device type "General" (Virtual) can be one of: 

0 = No Info 
1 = Sunny 
2 = Partly Cloudy 
3 = Cloudy 
4 = Rain 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Temperature/barometer==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEMP;BAR;BAR_FOR;ALTITUDE

The above sets the parameters for a Temp+Humidity+Barometer device 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEMP = Temperature 
*BAR = Barometric pressure 
*BAR_FOR = Barometer forecast 
*ALTITUDE= Optional. Not used at the moment, can be 0 

 
Barometer forecast can be one of: 
0 = Stable 
1 = Sunny 
2 = Cloudy 
3 = Unstable 
4 = Thunderstorm 
5 = Unknown 
6 = Cloudy/Rain 
 

Barometer forecast of other device types can be one of: 
0 = Heavy Snow 
1 = Snow 
2 = Heavy Rain 
3 = Rain 
4 = Cloudy 
5 = Some Clouds 
6 = Sunny 
7 = Unknown 
8 = Unstable 
9 = Stable 

 

<source lang="json">{
"status": "OK",
"title": "Update Device"
}</source>

==Rain==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=RAINRATE;RAINCOUNTER

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*RAINRATE = amount of rain in last hour in [mm x 100]
*RAINCOUNTER = continues counter of fallen Rain in [mm]

==Soil Moisture==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=MOISTURE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*MOISTURE = moisture content in cb 0-200 where:

00 - 09 = saturated,
10 - 19 = adequately wet,
20 - 59 = irrigation advice,
60 - 99 = irrigation,
100-200 = Dangerously dry,

==Wind==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=WB;WD;WS;WG;22;24

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*WB = Wind bearing (0-359) 
*WD = Wind direction (S, SW, NNW, etc.) 
*WS = 10 * Wind speed [m/s] 
*WG = 10 * Gust [m/s] 
*22 = Temperature 
*24 = Temperature Windchill 

==UV==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=UV;TEMP

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*UV = Float (example: 2.1) with current UV reading. 
*TEMP = temperature (only for UV subtype TFA (3), else specify 0)

Don't loose the ";0" at the end - without it database may corrupt.

If no temp is in use, specify 0 as temperature

==Counter==

/json.htm?type=command&param=udevice&idx=IDX&svalue=COUNTER

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*COUNTER = Integer of the overall total counter (Energy, Volume, Custom). 

When there is a counter created, there is a possibility to change the units by clicking on "Change" at the utility tab.

*Energy (reports kWh), give COUNTER value in Wh, integer 
*Energy Generated (reports kWh). give COUNTER value in Wh, integer 
*Gas (reports m3) , give COUNTER value in liter (1000 liter = 1 m³), integer 
*Water (reports m3), give COUNTER value in liter (1000 liter = 1 m³), integer 
*Counter (no unit) 
*Time (min?), seems to be obsolete, use Counter instead and use the time units as desired (eg Sec, min, hrs) 

The counter will be treated with the divider which is defined in the parameters in the application settings (menu setup-settings, tab counters). For example if the counter is set to "Water" and the value is passed as liters, the divider must set to 1000 (as the unit is m3).

The divider should also be used on Cutom if you want to report on digits. Eg if you set Unit to Euro but want to report on cents (eg 0.30) then you have to supply the value in cents (1 euro = 100 cents) and use the divider 100.

The device displays 2 values: 

*The status is the overall total volume (or counter). 
*The volume (or counter) of the day (in the top right corner). 

The today's volume (or counter) is calculated from the total volume (or counter).

==Counter Incremental==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=INCREMENT

INCREMENT = Integer of the increment of the counter. For Counters the standard counter dividers apply (menu setup - settings - tab counters)

will increment the counter value by 1. To reset an incremental counter, set the svalue to a ''negative'' integer equal to the current total of the counter.

==Electricity (instant and counter)==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=POWER;ENERGY

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*POWER = current power (W)
*ENERGY = Integer, total cumulative energy in Watt-hours (Wh) 

(Energy Read type (use edit button to change): Default: From Device. If the device is not able to send the ENERGY counter values you choose "Energy read : Computed". This will ignore ENERGY counter values and Domoticz will calculate the Energy (kWh) internally based on the (previous/current) POWER (Watt) values. By design this is less accurate then using the ENERGY counter when using them "from Device".)

Domoticz will calculate the today values based on the delta's in the total cumulative energy of today.

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

Note: This device will show in Domoticz as type "General, kWh"

==Managed counter==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = Integer, total cumulative counter energy (Wh, can be set to -1 if unknown or unused, in that case it won't show on dashboard or in logs)
*USAGE = energy usage in Watt-hours (Wh).

Managed counter will not transfer automatically every day data from device status to history log, it's up to an external script or plugin to insert data in history log database (useful to show non realtime consumption of energy provider that put energy information "in the cloud").

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

To insert data in history log:
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = total cumulative counter energy (Wh, can be set to -1 if unknown or unused, in that case it won't show on dashboard or in logs)
*USAGE = energy usage in Watt-hours (Wh)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

==Electricity Current/Ampere 3 Phase==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=Ampere_1;Ampere_2;Ampere_3;

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*Ampere_1 = Ampere value Phase 1
*Ampere_2 = Ampere value Phase 2
*Ampere_3 = Ampere value Phase 3

==Electricity P1 smart meter==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*USAGE1= integer, total cumulative energy usage meter tariff 1 in Wh.
*USAGE2= integer, total cumulative energy usage meter tariff 2 in Wh.
*RETURN1= integer, total cumulative energy return meter tariff 1 in Wh.
*RETURN2= integer, total cumulative energy return meter tariff 2 in Wh.
*CONS= actual usage power (Watt)
*PROD= actual return power (Watt)

USAGE and RETURN are total cumulative counters (they should only count up). 
For USAGE and RETURN supply the data in total Wh with no decimal point. 
(So if your meter displays f.i. USAGE1= 523,66 KWh you need to send 523660) 
Domoticz will calculate the today values based on the delta's in the total cumulative energy of today.

For Counters the standard counter dividers apply (menu setup - settings - tab counters)

==Air quality==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=PPM

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*PPM = CO2-concentration

Calculated status from PPM value:

airquality < 700 status text: "Excellent"

airquality < 900 status text: "Good"

airquality < 1100 status text:"Fair"

airquality < 1600 status text: "Mediocre"

airquality >= 1600 status text: "Bad"

==Pressure==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=BAR

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*BAR = Pressure in Bar

Create sensor under Hardware > Dummy > Create virtual sensor

==Percentage==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=PERCENTAGE

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*PERCENTAGE = Percentage

==Visibility==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VISIBILITY

*IDX = id of your device (this number can be found in the devices tab in the column "IDX")
*VISIBILITY = in KM

==Gas==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE

*USAGE= Integer, Gas usage in liter (1000 liter = 1 m³) 

So if your gas meter shows f.i. 145,332 m³ you should send 145332. 
The USAGE is the total usage in liters from start, not f.i. the daily usage.
For Counters the divider is used from menu setup - settings, tab Counters

==Lux==

/json.htm?type=command&param=udevice&idx=IDX&svalue=VALUE

*IDX = device ID of Lux device
*VALUE = value of luminosity in Lux (INTEGER/FLOAT)

==Voltage==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VOLTAGE

*IDX = device ID of Voltage device
*VALUE = value of voltage sensor in Volts

Create sensor under Hardware > Dummy > Create virtual sensor

==Text sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=TEXT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*TEXT = Text you want to display

==Alert sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=LEVEL&svalue=TEXT

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*Level = (0=gray, 1=green, 2=yellow, 3=orange, 4=red)
*TEXT = Text you want to display

==Distance sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=DISTANCE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*DISTANCE = distance in cm or inches, can be in decimals. For example 12.6

==Selector Switch==

/json.htm?type=command&param=switchlight&idx=IDX&switchcmd=Set%20Level&level=LEVEL

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*LEVEL = level of your selector (This number can be found in the edit selectors page, in the column "Level", 0 = Off)

==Custom Sensor==

/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=VALUE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*VALUE = Value (like 12.345) 

==Opentherm Gateway Custom command==

/json.htm?type=command&param=sendopenthermcommand&idx=IDX&cmnd=COMMAND

*IDX = id of your hardware Opentherm device (This number can be found in the ID column in menu Setup-Hardware)
*COMMAND = The actual custom OTGW command like TC=20 

==Note on counters==
Usually, counters are updated daily to feed week/month/year history log views. Starting version 4.11774, if you want to disable that behavior to control everything from an external script or a plugin (already the case for managed counter), you can set the "'''DisableLogAutoUpdate'''" device option to "'''true'''", for instance in a Python plugin:
Domoticz.Device(Name="MyCounter", Unit=1, Type=0xfa, Subtype=0x01, Options={"DisableLogAutoUpdate" : "true").Create()

Starting version 4.11774, you can too directly insert data in in history log. Set the "'''AddDBLogEntry'''" device option to "'''true'''", for instance in a Python plugin:
Domoticz.Device(Name="MyCounter", Unit=1, Type=0xfa, Subtype=0x01, Options={"AddDBLogEntry" : "true").Create()
With a json the parameter AddDBLogEntry:true should first base64 encoded
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=CODE
To set AddDBLogEntry:true, you must call:
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=QWRkREJMb2dFbnRyeTp0cnVl

AddDBLogEntry can be combined with other entries in the options field if separated by a semicolon for example to set:
ValueQuantity:2;AddDBLogEntry:true

You call:
/json.htm?type=setused&idx=DEVICE_IDX&name=SENSORNAME&switchtype=SUBTYPE_VALUE&used=true&options=VmFsdWVRdWFudGl0eToyO0FkZERCTG9nRW50cnk6dHJ1ZQ==
Also please note if the device is edited using the domoticz device screen then this AddDBLogEntry disappears and needs to be added again.

Then, depending on counters, you can insert values in history log. For most counters:
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=COUNTER;USAGE;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*COUNTER = total cumulative counter energy (Wh)
*USAGE = energy usage in Watt-hours (Wh)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

Note: COUNTER and USAGE should be positive. Any negative value will result in 0 instead

For multi meters (P1 Smart Meter, CM113, Electrisave and CM180i):
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD;DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*USAGE1= energy usage meter tariff 1, This is an incrementing counter
*USAGE2= energy usage meter tariff 2, This is an incrementing counter
*RETURN1= energy return meter tariff 1, This is an incrementing counter
*RETURN2= energy return meter tariff 2, This is an incrementing counter
*CONS= actual usage power (Watt)
*PROD= actual return power (Watt)
*DATE = date with %Y-%m-%d format (for instance 2019-09-24) to put data in last week/month/year history log, or "%Y-%m-%d %H:%M:%S" format (for instance 2019-10-03 14:00:00) to put data in last days history log

or
/json.htm?type=command&param=udevice&idx=IDX&nvalue=0&svalue=USAGE1;USAGE2;RETURN1;RETURN2;CONS;PROD;COUNTER1;COUNTER2;COUNTER3;COUNTER4;DATE
as previously, plus absolute counter values
 

==Additional parameters (signal level & battery level)==
There are two additional and optional parameters for the above commands, to specify the '''signal level''' (default 12) and the '''battery level''' (default 255) 

/json.htm?type=command&param=udevice&idx=<idx>&nvalue=<numeric value>&svalue=<string value>&rssi=<numeric value>&battery=<numeric value>

battery level 255 = no battery device, else 0-100 
example: '''&rssi=10&battery=89'''

=Security=

==Get Password==
to be able to set the security status, the (encoded) password is required.

<code>/json.htm?type=command&param=getsettings</code><source lang="json">{
"AcceptNewHardware": 0,
"ActiveTimerPlan": 2,
"AllowWidgetOrdering": 1,
"AuthenticationMethod": 1,
"BatterLowLevel": 0,
"CM113DisplayType": 0,
.....
"SecPassword": "bfa2bea3x",
....
"WindUnit": 4,
"cloudenabled": true,
"status": "OK",
"title": "settings"
}</source>

get the value from key "SecPassword" ;for the purpose of this wiki we assume the value read is "bfa2bea3x"

==Get security state==
/json.htm?type=command&param=getsecstatus
<source lang="json">{
"secondelay": 2,
"secstatus": 1,
"status": "OK",
"title": "GetSecStatus"
}</source>
where secstatus is
0 = Disarmed
1 = Arm Home
2 = Arm Away
3 = Unknown

==Set security state==
/json.htm?type=command&param=setsecstatus&secstatus=<status>&seccode=bfa2bea3x
<source lang="json">{
"status": "OK",
"title": "SetSecStatus"
}</source>

=Smoke Detection=
==Activate==
<code>/json.htm?type=command&param=switchlight&idx=<IDX>&switchcmd=On</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>

==Deactivate==
<code>/json.htm?type=command&param=switchlight&idx=<IDX>&switchcmd=Off</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>
==Reset==
<code>/json.htm?type=command&param=resetsecuritystatus&idx=<IDX>&switchcmd=Off</code>
<source lang="json">{
"status": "OK",
"title": "ResetSecurityStatus"
}</source>

<code>/json.htm?type=command&param=resetsecuritystatus&idx=3456&switchcmd=Normal</code>
<source lang="json">{
"status": "OK",
"title": "SwitchLight"
}</source>

=User variables=

==Add a new variable==

*USERVARIABLENAME with the name of the variable
*USERVARIABLETYPE is a digit (0,1,2,3,4) or a string (Integer, Float, String, Date, Time)

0 = Integer, e.g. -1, 1, 0, 2, 10
1 = Float, e.g. -1.1, 1.2, 3.1
2 = String
3 = Date in format DD/MM/YYYY
4 = Time in 24 hr format HH:MM

*USERVARIABLEVALUE with the value

All formats are checked by the api, when the variable does not match the required format it is not stored.

/json.htm?type=command&param=adduservariable&vname=USERVARIABLENAME&vtype=USERVARIABLETYPE&vvalue=USERVARIABLEVALUE

<source lang="json">{
"status": "OK",
"title": "AddUserVariable"
}</source>

==Update an existing variable==

Remember to change:

*USERVARIABLENAME with the name of your variable
*USERVARIABLETYPE according to the table from [[Domoticz_API/JSON_URL's#Add_a_new_variable|"Add a new variable"]]
*USERVARIABLEVALUE with the new value

Note: events will only be triggered when the variabletype and variablename are not changed by the update command.

/json.htm?type=command&param=updateuservariable&vname=USERVARIABLENAME&vtype=USERVARIABLETYPE&vvalue=USERVARIABLEVALUE

<source lang="json">{
"status": "OK",
"title": "UpdateUserVariable"
}</source>

==List all variables==

/json.htm?type=command&param=getuservariables

<source lang="json">{
"result": [
{
"LastUpdate": "2020-01-13 09:04:17",
"Name": "setup-test",
"Type": "2",
"Value": "Hi",
"idx": "1"
},
{
"LastUpdate": "2020-02-17 16:48:03",
"Name": "presence-test",
"Type": "0",
"Value": "1",
"idx": "2"
},
....
{
"LastUpdate": "2021-03-02 21:10:54",
"Name": "UV_Night",
"Type": "2",
"Value": "21:11",
"idx": "44"
}
],
"status": "OK",
"title": "GetUserVariables"
}
</source>

==List one variable==

/json.htm?type=command&param=getuservariable&idx=IDX

*IDX = id of your variable (This number can be found using the "List all variables" call above)

<source lang="json">{
"result": [
{
"LastUpdate": "2021-03-02 21:10:54",
"Name": "UV_Night",
"Type": "2",
"Value": "21:11",
"idx": "44"
}
],
"status": "OK",
"title": "GetUserVariable"
}</source>

==Delete a variable==

*IDX = id of your variable (This number can be found using the "List all variables" call above)

/json.htm?type=command&param=deleteuservariable&idx=IDX

<source lang="json">{
"status": "OK",
"title": "DeleteUserVariable"
}</source>

=trigger dzVents script using customEvent dzVents 3.0.0=

/json.htm?type=command&param=customevent&event=MyEvent&data=MyData

<source lang="json">{
"status": "OK",
"title": "Custom Event"
}</source>

=Room Plans=

==List all rooms==

<code>/json.htm?type=command&param=getplans&order=name&used=true</code>
<source lang="json">{
"result": [
{
"Devices": 6,
"Name": "Google Calendars",
"Order": "2",
"idx": "2"
},
{
"Devices": 2,
"Name": "Private",
"Order": "3",
"idx": "3"
},
{
"Devices": 1,
"Name": "EVOHome",
"Order": "4",
"idx": "4"
},
{
"Devices": 0,
"Name": "testPlan",
"Order": "5",
"idx": "5"
}
],
"status": "OK",
"title": "Plans"
}</source>

==List all devices in a room==

*IDX = id of your room

/json.htm?type=command&param=getplandevices&idx=IDX
Show idx, name of the device like:
<source lang="json">{
"result": [
{
"DevSceneRowID": "492",
"Name": "device name",
"devidx": "492",
"idx": "9",
"order": "9",
"type": 0
}
],
"status": "OK",
"title": "GetPlanDevices"
}</source>

/json.htm?type=devices&plan=IDX
show details of the devices like

<source lang="json">{
"ActTime": 1569909986,
"AstrTwilightEnd": "21:14",
"AstrTwilightStart": "05:50",
"CivTwilightEnd": "19:54",
"CivTwilightStart": "07:09",
"DayLength": "11:39",
"NautTwilightEnd": "20:34",
"NautTwilightStart": "06:30",
"ServerTime": "2019-10-01 08:06:26",
"SunAtSouth": "13:32",
"Sunrise": "07:42",
"Sunset": "19:21",
"app_version": "4.11337",
"result": [
{
"AddjMulti": 1,
"AddjMulti2": 1,
"AddjValue": 0,
"AddjValue2": 0,
"BatteryLevel": 255,
"CustomImage": 0,
"Data": "19.5 C, (13.5 C), PermanentOverride",
"Description": "",
"Favorite": 1,
"HardwareID": 30,
"HardwareName": "Evohome",
"HardwareType": "Evohome via Web API",
"HardwareTypeVal": 75,
"HaveTimeout": false,
"ID": "1168736",
"LastUpdate": "2019-10-01 08:05:35",
"Name": "Device name",
"Notifications": "false",
"PlanID": "4",
"PlanIDs": [
4
],
"Protected": false,
"SetPoint": 13.5,
"ShowNotifications": true,
"SignalLevel": 10,
"Status": "PermanentOverride",
"SubType": "Zone",
"Temp": 19.5,
"Timers": "false",
"Type": "Heating",
"TypeImg": "override_mini",
"Unit": 7,
"Used": 1,
"XOffset": "0",
"YOffset": "0",
"idx": "492"
}
],
"status": "OK",
"title": "Devices"
}</source>

=Timer Plans=

==List all Timerplans==

<code>/json.htm?type=command&param=gettimerplans</code>
<source lang="json">{
"result": [
{
"Active": false,
"Name": "Default",
"idx": 0
},
{
"Active": true,
"Name": "Holiday",
"idx": 1
},
{
"Active": false,
"Name": "Day off (including weekend)",
"idx": 2
}
],
"status": "OK",
"title": "GetTimerPlans"
}</source>

==Add Timerplan==

<code>/json.htm?type=command&param=addtimerplan&name=newTimerplan</code>
<source lang="json">{
"status": "OK",
"title": "AddTimerPlan"
}</source>

==Change Timerplan name==

<code>/json.htm?type=command&param=updatetimerplan&idx=3&name=newname</code>
<source lang="json">{
"status": "OK",
"title": "UpdateTimerPlan"
}</source>

==Duplicate Timerplan==

This will copy all existing timers from timerplan with idx 3 to a new plan

<code>/json.htm?type=command&param=duplicatetimerplan&idx=3&name=duplicatename</code>
<source lang="json">{
"status": "OK",
"title": "DuplicateTimerPlan"
}</source>

==Make Timerplan active==

This will make the timerplan with idx 2 the active one

<code>/json.htm?type=command&param=setactivetimerplan&ActiveTimerPlan=2</code>
<source lang="json">{
"status": "OK",
"title": "SetActiveTimerPlan"
}</source>

=History=

==Switch/Light devices==
<code>/json.htm?type=command&param=getlightlog&idx=IDX</code>

Shows the log entries of the IDX switch/light device.

===Delete history log===
<code>/json.htm?type=command&param=clearlightlog&idx=<idx></code>

Deletes all the log entries from the DB for a specific IDX and device displays the current switch/light state.

==Text devices==
<code>/json.htm?type=command&param=gettextlog&idx=IDX</code>

Shows the log entries of the IDX text device.

===Delete history log===
<code>/json.htm?type=command&param=clearlightlog&idx=<idx></code>

Deletes all the log entries from the DB for a specific IDX and text device displays the current text.

==Temperature==
<code>/json.htm?type=command&param=graph&sensor=temp&idx=IDX&range=[day|month|year]&actyear=YYYY</code>

==Custom sensor==

Totals by period :
<code>/json.htm?type=command&param=graph&sensor=Percentage&idx=IDX&range=day</code><source lang="json">{{
"result" :
[
{
"d" : "2021-02-04 16:40",
"v" : "308.6"
},
{
"d" : "2021-02-04 16:45",
"v" : "308.6"
},
.....

],
"status" : "OK",
"title" : "Graph Percentage day"
}
</source>

<code>/json.htm?type=command&param=graph&sensor=Percentage&idx=IDX&range=[day|month|year|year&actyear=YYYY]</code><source lang="json">{
"result" :
[
{
"d" : "2021-01-18",
"v_avg" : "308.6",
"v_max" : "309.6",
"v_min" : "307.6"
},
{
"d" : "2021-01-19",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
},
{
"d" : "2021-01-21",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
},
...

{
"d" : "2021-02-18",
"v_avg" : "308.6",
"v_max" : "310.6",
"v_min" : "306.6"
}
],
"status" : "OK",
"title" : "Graph Percentage <...>"
}
</source>

==Energy, Gas, Water==

Instantaneous consumption :

/json.htm?type=command&param=graph&sensor=counter&idx=IDX&range=day&method=1

Totals by period :
<code>/json.htm?type=command&param=graph&sensor=counter&idx=IDX&range=[day|month|year|year&actyear=YYYY|YYYY-MM-DDTYYYY-MM-DD]</code>

Only for counters it is possible to specify a date range for long history data (not for short log data):
&range=YYYY-MM-DDTYYYY-MM-DD
Notice the "T" between the dates in range.

==Deleting History log entries==

===delete a single data point or day===

/json.htm?type=command&param=deletedatapoint&idx=IDX&date=DATE

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*DATE = date in %Y-%m-%d format (for instance 2021-02-26) will delete history data of that particular day (one entry from long term history and max 120 entries from short term history log)
*DATE = date in "%Y-%m-%d%20%H:%M:%S" format (for instance 2019-10-03%2014:00:00) will delete history data of that particular time (one entry from short term history log)

<source lang="json">{
"status": "OK",
"title": "deletedatapoint"
}
</source>

===delete a date range of data points===

/json.htm?type=command&param=deletedaterange&idx=IDX&fromdate=FROMDATE&todate=TODATE V2020.2 build >= 13027 

*IDX = id of your device (This number can be found in the devices tab in the column "IDX")
*FROMDATE = date in %Y-%m-%d or date in "%Y-%m-%d%20%H:%M:%S"format (for instance 2021-02-26 / 2019-10-03%2014:00:00) will delete history data (from short and long history tables) starting with that day / time
*TODATE = date in %Y-%m-%d or date in "%Y-%m-%d%20%H:%M:%S"format (for instance 2021-02-26 / 2019-10-03%2014:00:00) will delete history data (from short and long history tables) ending with that day / time

<source lang="json">{
"status": "OK",
"title": "deletedaterange"
}
</source>

=Device Timer Schedules=
==Get all schedules (timers)==
/json.htm?type=command&param=getschedules

<source lang="json">{
"result" : [
{
"Active" : "true",
"Date" : "",
"Days" : 128,
"DevName" : "Porch Light",
"DeviceRowID" : 52,
"Hue" : 0,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2016-04-01 20:33:00",
"Time" : "00:20",
"TimerCmd" : 0,
"TimerID" : 9,
"TimerType" : 4,
"TimerTypeStr" : "After Sunset",
"Type" : "Device"
},
</source>

==Get all schedules(timers) for all Devices==

/json.htm?type=command&param=getschedules&filter=device

<source lang="json">{
"result": [
{
"Active": "true",
"Color": "",
"Date": "",
"Days": 128,
"DevName": "coffeeSwitch",
"DeviceRowID": 1014,
"IsThermostat": "false",
"Level": 100,
"MDay": 0,
"Month": 0,
"Occurence": 0,
"Randomness": "false",
"ScheduleDate": "2021-03-11 06:01:00",
"Time": "06:01",
"TimerCmd": 0,
"TimerID": 62,
"TimerType": 2,
"TimerTypeStr": "On Time",
"Type": "Device"
},
{
"Active": "true",
"Color": "",
"Date": "",

"TimerType": 2,
"TimerTypeStr": "On Time",
"Type": "Device"
}
],
"status": "OK",
"title": "Schedules"
}
</source>

==Get all schedules(timers) for one Device==

/json.htm?type=command&param=gettimers&idx=timerID

===Type returns===

*0: Before Sunrise
*1: After Sunrise
*2: On Time
*3: Before Sunset
*4: After Sunset
*5: Fixed Date/Time
*6: Odd Day Numbers
*7: Even Day Numbers
*8: Odd Week Numbers
*9: Even Week Numbers
*10: Monthly
*11: Monthly (Weekday)
*12: Yearly
*13: Yearly (Weekday)
*14: Before Sun at South
*15: After Sun at South
*16: Before Civil Twilight Start
*17: After Civil Twilight Start
*18: Before Civil Twilight End
*19: After Civil Twilight End
*20: Before Nautical Twilight Start
*21: After Nautical Twilight Start
*22: Before Nautical Twilight End
*23: After Nautical Twilight End
*24: Before Astronomical Twilight Start
*25: After Astronomical Twilight Start
*26: Before Astronomical Twilight End
*27: After Astronomical Twilight End

<source lang="json">{
"result" :
[
{
"Active" : "true",
"Cmd" : 0,
"Color" : "",
"Date" : "",
"Days" : 128,
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"Time" : "08:30",
"Type" : 23,
"idx" : "45"
}
],
"status" : "OK",
"title" : "Timers"
}
</source>

==Get all schedules(timers) for all Scenes==
/json.htm?type=command&param=getschedules&filter=scene

<source lang="json">{
"result" :
[
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Lights",
"DeviceRowID" : 6,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 07:01:00",
"Time" : "00:03",
"TimerCmd" : 1,
"TimerID" : 4,
"TimerType" : 0,
"TimerTypeStr" : "Before Sunrise",
"Type" : "Scene"
},
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Garden lights",
"DeviceRowID" : 6,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 09:00:00",
"Time" : "09:00",
"TimerCmd" : 1,
"TimerID" : 6,
"TimerType" : 2,
"TimerTypeStr" : "On Time",
"Type" : "Scene"
},
{
"Active" : "true",
"Color" : "",
"Date" : "",
"Days" : 128,
"DevName" : "Frontdoor",
"DeviceRowID" : 5,
"IsThermostat" : "false",
"Level" : 100,
"MDay" : 0,
"Month" : 0,
"Occurence" : 0,
"Randomness" : "false",
"ScheduleDate" : "2021-03-12 01:30:00",
"Time" : "01:30",
"TimerCmd" : 0,
"TimerID" : 2,
"TimerType" : 2,
"TimerTypeStr" : "On Time",
"Type" : "Scene"
}
],
"status" : "OK",
"title" : "Schedules"
}
</source>

==Get all schedules(timers) for one Scene==
/json.htm?type=command&param=getscenetimers&idx=sceneID

<source lang="json">{
"result": [{
"Active": "true",
"Cmd": 0,
"Date": "",
"Days": 128,
"Level": 100,
"MDay": 0,
"Month": 0,
"Occurence": 0,
"Randomness": "false",
"Time": "01:30",
"Type": 2,
"idx": "2"
}
],
"status": "OK",
"title": "SceneTimers"
}</source>

==Get all schedules(timers) for all Thermostats==

/json.htm?type=command&param=getschedules&filter=thermostat
<source lang="json">{
"status": "OK",
"title": "Schedules"
}</source>

==Get all schedules(timers) for one Thermostat==

/json.htm?type=command&param=getsetpointtimers&idx=timerID
<source lang="json">{
"status": "OK",
"title": "SetpointTimers"
}</source>

==Enable specific schedule(timer) for Devices==

/json.htm?type=command&param=enabletimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "EnableTimer"
}</source>

==Disable specific schedule(timer) for Devices==

/json.htm?type=command&param=disabletimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DisableTimer"
}</source>

==Delete a specific schedule(timer) for Devices==

/json.htm?type=command&param=deletetimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DeleteTimer"
}</source>

==Enable specific schedule(timer) for Thermostats==

/json.htm?type=command&param=enablesetpointtimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "EnableSetpointTimer"
}</source>

==Disable specific schedule(timer) for Thermostats==

/json.htm?type=command&param=disablesetpointtimer&idx=timerID
<source lang="json">{
"status": "OK",
"title": "DisableSetpointTimer"
}</source>

==Delete a specific schedule(timer) for Thermostats==
/json.htm?type=command&param=deletesetpointtimer&idx=timerID

<source lang="json">{
"status": "OK",
"title": "DeleteSetpointTimer"
}</source>

==Update parameters for a specific schedule(timer) for Devices==
/json.htm?type=command&param=updatetimer&idx=timerID&active=true&timertype=3&hour=0&min=20&randomness=true&command=0&days=12345<nowiki></source></nowiki>

*idx = timerID
*active = true/false
*timertype - see Get all schedules(timers) for one Device for timerTypeDefinition
*hour = hour
*min = minute
*randomness = true/false
*command = On=0 / Off=1 (inverted logic)
*days = 1=Mon, 2=Tue, 3=Wed, 4=Thurs, 5=Fri, 6=Sat, 7=Sun

==Create a new schedule(timer) for an existing device==

/json.htm?type=command&param=addtimer&idx=DeviceRowID&active=true&timertype=2&hour=0&min=20&randomness=false&command=0&days=1234567

<source lang="json">{
"status": "OK",
"title": "AddTimer"
}</source>

*idx = DeviceRowID = index of your device (other commands use a timerID as idx but here we use DeviceRowID).
*active = true/false
*timertype - see Get all schedules(timers) for one Device for timerTypeDefinition
*hour = hour
*min = minute
*randomness = true/false
*command = On=0 / Off=1 (inverted logic)
*days = 1=Mon, 2=Tue, 3=Wed, 4=Thurs, 5=Fri, 6=Sat, 7=Sun

==Clear all schedules(timers) for a particular device==

/json.htm?type=command&param=cleartimers&idx=DeviceRowID

<source lang="json">{
"status": "OK",
"title": "ClearTimer"
}
</source>

*idx = DeviceRowID = index of your device (other commands use a timerID as idx but here we use DeviceRowID).

==Enable specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=enablescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "EnableSceneTimer"
}</source>

==Disable specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=disablescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "DisableSceneTimer"
}
</source>

==Delete a specific schedule(timer) for Scenes/Groups==

/json.htm?type=command&param=deletescenetimer&idx=sceneID

<source lang="json">{
"status": "OK",
"title": "DeleteSceneTimer"
}
</source>

=Notifications=

==Get all notification types==

<code>/json.htm?type=command&param=getnotifications</code><source lang="json">{
"notifiers": [{
"description": "browser",
"name": "browser"
}, {
"description": "clickatell",
"name": "clickatell"
}, {
"description": "email",
"name": "email"
}, {
"description": "fcm",
"name": "fcm"
}, {
"description": "http",
"name": "http"
}, {
"description": "kodi",
"name": "kodi"
}, {
"description": "lms",
"name": "lms"
}, {
"description": "prowl",
"name": "prowl"
}, {
"description": "pushalot",
"name": "pushalot"
}, {
"description": "pushbullet",
"name": "pushbullet"
}, {
"description": "pushover",
"name": "pushover"
}, {
"description": "pushsafer",
"name": "pushsafer"
}, {
"description": "telegram",
"name": "telegram"
}
],
"status": "OK",
"title": "Notifications"
}</source>

==Get device notifications==

/json.htm?idx=<deviceIDX>&param=getnotificationtypes&type=command
 <source lang="json">{
"result":
[
{
"ptag": "S",
"text": "Switch On",
"val": 7
}
],
"status": "OK",
"title": "GetNotificationTypes"
}</source>

<code>/json.htm?type=command&param=getnotifications&idx=<deviceIDX></code><source lang="json">{
"notifiers": [{
"description": "browser",
"name": "browser"
}, {
"description": "clickatell",
"name": "clickatell"
}, {
"description": "email",
"name": "email"
}, {
"description": "fcm",
"name": "fcm"
}, {
"description": "http",
"name": "http"
}, {
"description": "kodi",
"name": "kodi"
}, {
"description": "lms",
"name": "lms"
}, {
"description": "prowl",
"name": "prowl"
}, {
"description": "pushalot",
"name": "pushalot"
}, {
"description": "pushbullet",
"name": "pushbullet"
}, {
"description": "pushover",
"name": "pushover"
}, {
"description": "pushsafer",
"name": "pushsafer"
}, {
"description": "telegram",
"name": "telegram"
}
],
"result": [{
"ActiveSystems": "clickatell;email;fcm;http;kodi;lms;prowl;pushalot;pushbullet;pushover;pushsafer;telegram",
"CustomMessage": "test",
"Params": "S",
"Priority": 0,
"SendAlways": false,
"idx": 3
}
],
"status": "OK",
"title": "Notifications"
}</source>

==Add device notification==

/json.htm?idx=<deviceIDX>&param=addnotification&tmsg=test&tpriority=0&tsendalways=true&tsystems=fcm;http&ttype=7&tvalue=0&twhen=0&type=command

<source lang="json">{
"status": "OK",
"title": "AddNotification"
}</source>

==Update device notifications==

/json.htm?devidx=<DeviceID>&idx=<notificationID>&param=updatenotification&taction=<action command>&tactive=<true/false>&tmsg=<msgText>&tpriority=<pri>&tsendalways=<true/false>&tsystems=<list of notification subsystems>&ttype=<notificationType>&tvalue=0&twhen=0&type=command
<source lang="json">{
"status": "OK",
"title": "UpdateNotification"
}</source>

==Delete device notification==

json.htm?idx=<notificationID>&param=deletenotification&type=command

<source lang="json">{
"status": "OK",
"title": "DeleteNotification"
}</source>

==Delete all device notifications==

/json.htm?idx=<deviceID>&param=clearnotifications&type=command&idx=nnn
<source lang="json">{
"status": "OK",
"title": "ClearNotification"
}</source>

=LMS and Kodi (Media Players)=
While both Logitech Media Server and Kodi can be controlled by JSON RPC commands sent directly to the URL of the LMS server or Kodi instance, it can be useful to use Domoticz as a tunnel/proxy to send a number of widely-used commands because you may have an external port already open for Domoticz and because Domoticz also supports HTTPS.

==LMS==

<source lang="json">/json.htm?type=command&param=lmsmediacommand&idx=nnn&action=ACTION</source>

where ACTION can be: Left, Right, Up, Down, Favorites, Browse, NowPlaying, Shuffle, Repeat, Play, Pause, Stop, Rewind, Forward, Mute, VolumeUp, VolumeDown, PowerOn and PowerOff.

==Kodi==

<source lang="json">/json.htm?type=command&param=kodimediacommand&idx=nnn&action=ACTION</source>

where ACTION can be: PlayPause, Stop, FastForward, BigStepForward, Rewind, BigStepBack, ShowSubtitles, FullScreen, VolumeUp, VolumeDown, ChannelUp, ChannelDown, Channels
Home, Back, ContextMenu, Info, Select, Down, Right, Up, Left

=Evohome=

These commands work regardless of which of the 3 implementation-modes for Evohome you have chosen for your system (WebAPI, USB device, Scripting). Some of them will also work for e.g. the Honeywell Round WiFi thermostat.

==Updating the evohome controller mode==

<source lang="json"> /json.htm?type=command&param=switchmodal&idx=<idx>&status=<status>&action=<action>&ooc=<ooc></source>

*'''<idx>''' id number of the evohome controller device in Domoticz
*'''<status>''' Auto, AutoWithReset, AutoWithEco, Away, DayOff, Custom, HeatingOff
*'''<action>''' (1 = run on action script, 0 = disable)
*'''<ooc>''' (1 = only trigger the event & log on change, 0 = always trigger & log)

===Specify an until date===

<source lang="json"> /json.htm?type=command&param=switchmodal&idx=<idx>&status=<status>&action=<action>&ooc=<ooc>&until=<until></source>

*as above
*'''<until>''' ISO date time to run until. Format example ''2018-09-15T15:53:00'' or ''2018-09-15T15:53:00+01:00'' with timezone.

Note: most controller modes do not support the ''time'' part of the ISO data and will only act upon the ''date'' portion - this will require at least the next day to be reflected in the date number to successfully trigger an update.

==Updating a zone setpoint==

<code>/json.htm?type=command&param=setsetpoint&idx=<idx>&setpoint=<setpoint>&mode=<mode>&used=true</code>

*'''<idx>''' id number of the relevant evohome zone device in Domoticz
*'''<setpoint>''' set point in degrees (will be ignored for Auto)
*'''<mode>''' Auto, TemporaryOverride, PermanentOverride, FollowSchedule
*'''used''' must be true

===Specifying a date/time for zone TemporaryOverride===

<code>/json.htm?type=command&param=setsetpoint&idx=<idx>&setpoint=<setpoint>&mode=TemporaryOverride&until=<until>&used=true</code>

*as above
*'''<until>''' ISO date time for the set point override. Format example ''2018-09-15T15:53:00'' or ''2018-09-15T15:53:00+01:00'' with timezone.

In this case, any combination of a date portion and a time portion that are in the future will meet with success.

==Turning HotWater ON/OFF==

<code>/json.htm?type=command&param=setused&idx=<idx>&setpoint=<setpoint>&state=<state>&mode=<mode>&used=true</code>

*'''<idx>''' id number of the evohome DHW temp device in Domoticz
*'''<setpoint>''' set point in degrees (will be ignored)
*'''<state>''' On, Off
*'''<mode>''' Auto, TemporaryOverride, PermanentOverride, FollowSchedule
*'''used''' must be true

=Configuring zwave devices=
Below mentioned commands are for the to be deprecated OpenZwave integration. Switch to [[Zwave-JS-UI]] as soon as possible!! 
==Listing zwave node parameters==
<source lang="json"> json.htm?type=command&param=getopenzwavenodes&idx=ControllerIDX</source>

*ControllerIDX = the idx of your OpenZWave USB controller device, as listed under the 'Setup --> Hardware' tab.

Example output:

<source lang="json">
{
"NodesQueried" : true,
"ownNodeId" : 1,
"result" : [
{
"Description" : "Neo CoolCam Door/Window Detector",
"HaveUserCodes" : false,
"HomeID" : 3554707869,
"IsPlus" : true,
"LastUpdate" : "2018-08-04 20:09:02",
"Manufacturer_id" : "0x0258",
"Manufacturer_name" : "Neo CoolCam",
"Name" : "Garage DOor",
"NodeID" : 40,
"PollEnabled" : "false",
"Product_id" : "0x1082",
"Product_name" : "Door/Window Detector",
"Product_type" : "0x0003",
"State" : "Sleeping",
"Version" : 4,
"config" : [
{
"LastUpdate" : "2018-08-01 09:06:45",
"help" : "This configuration parameter that can be used to adjust the amount of delay before the OFF command is transmitted. This parameter can be configured with the value of 0 through 65535, where 0 means send OFF command immediately and 65535 means 65535 seconds of delay.",
"index" : 1,
"label" : "Configuring the OFF Delay",
"type" : "short",
"units" : "second",
"value" : "0"
},
{
"LastUpdate" : "2018-08-01 09:06:45",
"help" : "Basic Set Command will be sent where contains a value when the door/window is opened or closed, the receiver will take it for consideration; for instance, if a lamp module is received the Basic Set Command of which value is decisive as to how bright of dim level of lamp module shall be.",
"index" : 2,
"label" : "Basic Set Level",
"type" : "byte",
"units" : "",
"value" : "255"
},
{
"LastUpdate" : "2018-08-03 07:55:52",
"help" : "",
"index" : 2000,
"label" : "Wake-up Interval",
"type" : "int",
"units" : "Seconds",
"value" : "43200"
}
],
"idx" : "11"
},
{
"Description" : "FIBARO System FGWPE/F Wall Plug",
"HaveUserCodes" : false,
"HomeID" : 3554707869,
"IsPlus" : false,
"LastUpdate" : "2018-08-05 12:12:24",
"Manufacturer_id" : "0x010f",
"Manufacturer_name" : "FIBARO System",
"Name" : "Studio",
"NodeID" : 5,
.
.
.

</source>

Note the ''node_idx'' towards the end of each device's entry (the "idx" : "11" in the example above for the Neo CoolCam Door/Window Detector). You don't see this node_idx in the regular devices tab for Domoticz, but it is the idx you'll need when changing a parameter through JSON (next section).

==Getting the battery levels==
<source lang="json"> /json.htm?type=command&param=zwavegetbatterylevels&idx=controlleridx</source>

*controlleridx = the idx of your OpenZWave USB controller device, as listed under the 'Setup --> Hardware' tab.

Example output:

<source lang="json">
{
"result" : [
{
"battery" : 255,
"nodeID" : 17,
"nodeName" : "Designlamp bij TV"
},
{
"battery" : 255,
"nodeID" : 19,
"nodeName" : "Lichtknopje voorkamer"
},
{
"battery" : 100,
"nodeID" : 33,
"nodeName" : "Rookmelder"
}
],
"status" : "OK",
"title" : "GetBatteryLevels"
}</source>

Note: a Battery level of 255 indicates either a non battery powered device, or a battery powered device which has not yet send a battery measurement to OpenZWave yet.

==Changing a zwave device parameter==
<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=node_idx&valuelist=plist</source>

*node_idx = the value found by searching through the output of ''openzwavenodes'' for the node in question (see above)
*plist = the (partially) URI encoded and BASE64 encoded parameter list

The ''plist'' entries start with an unencoded decimal item number preceded by and followed by an underscore (e.g. _7_), followed by the correctly-encoded string. You can check out the encodings at the following links: [https://www.base64decode.org base64decode] and at [https://www.urlencoder.org urlencode]. In Base64, 'Enable' is written as 'RW5hYmxl', so it looks odd but it's easy once you grasp it.

For example, if you are configuring a NEO Coolcam Siren through JSON,

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=7_QWxhcm0gbXVzaWM%3D</source>

would change parameter 7 (Configure Default Siren On Mode) to 'Alarm music', while

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=7_RG9vciBiZWxsIG11c2lj%3D</source>

would change it to 'Door bell music' (because 'RG9vciBiZWxsIG11c2lj' is the result of Base64 encoding 'Door bell music'). Note: Any '%3D' and such in the ''plist'' are the result of URI encoding an '=' or other non-alphanumeric character.

The easiest way to learn about this is to change a zwave device parameter manually using your browser while you have '''developer tools''' enabled (hit 'ctrl-shift-i' in Chrome). Look under the ''network'' tab at the JSON sent back by the browser to Domoticz when you click on 'Apply Configuration for This Device'.

<source lang="json"> /json.htm?type=command&param=applyzwavenodeconfig&idx=10&valuelist=3_MjU1_1_SGlnaA%3D%3D_
2_MSBtaW51dGU%3D_4_TG93_5_MTA%3D_6_MQ%3D%3D_7_QWxhcm0gbXVzaWM%3D_8_RW5hYmxl_9_RGlzYWJsZQ%3D%3D_</source>

The browser will actually send the full parameter list to Domoticz, including the unchanged values of any parameters you didn't alter. If you modify one of them, however, you'll see that edit reflected in the Base64-encoded JSON string.

[[File:Screenshotjsondebug.png]]

=Language-specific JSON examples=
The following tiny code snippets demonstrate the syntax for using JSON with Domoticz from some popular programming languages.

==Bash==
A bash script to query the json result of a temperature device and print the temperature value <source lang="bash">
#!/bin/bash
curl -s 'http://192.168.178.12:8080/json.htm?type=devices&rid=104' | jq .result[0].Temp | sed 's/\"//g' | awk '{ print $1 }'
</source>

A simple bash script can be used to get the device status, by executing for example:<syntaxhighlight lang="bash">
#!/bin/bash
DOMOTICZ_URL="http://localhost:8080"
DEVICE_IDX=1209

status=`curl -s "${DOMOTICZ_URL}/json.htm?type=command&param=getdevices&rid=${DEVICE_IDX}" | jq '.result[0].Data' |tr -d \"`
#status variable assumes value Off or On, in case of light device.
if [ "a${status}" == "aOff" ]; then
# device status is Off
# ...
else
# device status is On
# ...
fi
</syntaxhighlight>

==PHP==
<source lang="php">
#!/usr/bin/php

<?php
$json_string = file_get_contents("http://192.168.178.12:8080/json.htm?type=devices&rid=110");
$parsed_json = json_decode($json_string, true);
$test_link = "/home/pi/output.txt";
$test_data = fopen ($test_link, "w+");
fwrite ($test_data, print_R($parsed_json, TRUE));
fclose ($test_data);
?>

</source>

==Python==
<source lang="python">
#!/usr/bin/python

import urllib
import urllib2
import requests

...

url = 'http://192.168.178.12:8080/json.htm?type=command&param=udevice&nvalue=0&idx='+idx+'&svalue='+sval
try:
request = urllib2.Request(url)
response = urllib2.urlopen(request)
except urllib2.HTTPError, e:
print e.code; time.sleep(60)
except urllib2.URLError, e:
print e.args; time.sleep(60)
</source>

==Perl==
<source lang="perl">

#!/usr/bin/perl

use LWP::UserAgent;
use JSON::XS;

$url{domo}=>'http://192.168.178.12:8080';
$idx=301;

$ua=LWP::UserAgent->new; $ua->timeout(5);
$retrieve=$ua->get($url{domo}.'/json.htm?type=devices&rid='.$idx);
$res=$retrieve->decoded_content;
if ($retrieve->is_success) { $jres = JSON::XS->new->allow_nonref->decode($res) } else { warn $retrieve->status_line };
$state=$$jres{result}[0]->{Status}; # 'On', 'Off', 'Open', 'Closed', etc
print "The switch state for idx $idx is currently '$state'\n";

</source>

Plugins

2026-06-25T15:49:09Z

Walter vl: /* Python Plugins List */ Wifitic

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|Garbage Calender NL
|garbage/waste collection schedule
|[https://forum.domoticz.com/viewtopic.php?t=44560 link]
|https://github.com/MadPatrick/domoticz_garbage
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|HP iLo monitor
|HP server monitor
|[https://forum.domoticz.com/viewtopic.php?t=44638 link]
|https://github.com/MadPatrick/domoticz_HP_ilo
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|KPN experia v10
|KPN Experia Box V10 Device Presence Tracker and control
|[https://forum.domoticz.com/viewtopic.php?t=44623 link]
|https://github.com/adrighem/domoticz-kpn-experia-v10
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|WiFiTic Teleinfo
|Cartelectronic WiFiTic module
|[https://forum.domoticz.com/viewtopic.php?t=44704 link]
|https://github.com/DebugBill/domoticz-wifitic
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:44:04Z

Walter vl: /* Python Plugins List */ experia

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|Garbage Calender NL
|garbage/waste collection schedule
|[https://forum.domoticz.com/viewtopic.php?t=44560 link]
|https://github.com/MadPatrick/domoticz_garbage
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|HP iLo monitor
|HP server monitor
|[https://forum.domoticz.com/viewtopic.php?t=44638 link]
|https://github.com/MadPatrick/domoticz_HP_ilo
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|KPN experia v10
|KPN Experia Box V10 Device Presence Tracker and control
|[https://forum.domoticz.com/viewtopic.php?t=44623 link]
|https://github.com/adrighem/domoticz-kpn-experia-v10
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:40:55Z

Walter vl: /* Python Plugins List */ HP Ilo server

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|Garbage Calender NL
|garbage/waste collection schedule
|[https://forum.domoticz.com/viewtopic.php?t=44560 link]
|https://github.com/MadPatrick/domoticz_garbage
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|HP iLo monitor
|HP server monitor
|[https://forum.domoticz.com/viewtopic.php?t=44638 link]
|https://github.com/MadPatrick/domoticz_HP_ilo
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:36:08Z

Walter vl: /* Python Plugins List */ Garbage

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|Garbage Calender NL
|garbage/waste collection schedule
|[https://forum.domoticz.com/viewtopic.php?t=44560 link]
|https://github.com/MadPatrick/domoticz_garbage
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:32:19Z

Walter vl: /* Python Plugins List */ Dreame vacuum

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dreame vacuum
|Dreame robot vacuums
|[https://forum.domoticz.com/viewtopic.php?t=44655 link]
|https://github.com/MadPatrick/domoticz_dreame/
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:28:42Z

Walter vl: /* Python Plugins List */ Kiosk browser

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|Fully Kiosk Browser
|to control Fully Kiosk Browser
|[https://forum.domoticz.com/viewtopic.php?t=44325 link]
|https://github.com/MadPatrick/domoticz_fullykiosk
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T15:25:38Z

Walter vl: /* Python Plugins List */ Home presence

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Home presence
|home presence detection using phone MAC addresses and arp-scan
|[https://forum.domoticz.com/viewtopic.php?t=44754 link]
|https://github.com/blooesky/Detect-Presence-at-Home---Domoticz-plugin
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T14:40:05Z

Walter vl: /* Python Plugins List */ TPlink router

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|TP-Link Router
|TP-Link routers supported by the <code>tplinkrouterc6u</code> library
|
|https://github.com/blooesky/Domoticz-TPLinkRouter
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Plugins

2026-06-25T14:37:36Z

Walter vl: /* Python Plugins List */ Marstek

===Python Plugins List===

This list in maintained by the community. If you have created a plugin please request a Wiki account by sending a private message (PM) to forum user '''gizmocuz'''.

Go to the link for installation and usage instructions. Also go to the Forum, [https://www.domoticz.com/forum/viewforum.php?f=65 section Python] to see more plugins.

Before installing a plugin visit page [[Using_Python_plugins]] for some prerequisites that have to be fullfilled. 

*Note 1: There is a Python Plugin named as "Python plugin Manager (PP-Manager)" that can be used to install other plugins. Still the plugin prerequisites (if any) should be installed manually. Domoticz restart required after every plugin installation. Most plugins run on all platforms supported by Domoticz but the PP-Manager itself currently is only for Debian Based Installations (Linux,Raspberry Pi). To use a plugin on a non-Debian platform follow the manual install instructions for the individual plugin itself
*Note 2: A second plugin manager (Domoticz Plugin Manager) is created with an extra User interface to select the plugins.

----

{| class="wikitable sortable"
|-
|'''Plugin Name'''
|'''Legacy Plugin Name/Remark'''
|'''Forum Link'''
|'''Github Link'''
|-
|Python Plugin Manager(Linux Only)
|
|
| [https: / www.domoticz.com wiki Python_Plugin_Manager |https://github.com/ycahome/pp-manager
|-
|Domoticz Plugin Manager
|
|
|https://github.com/stas-demydiuk/domoticz-plugins-manager
|-
|AirPurifier
|Xiaomi AirPurifier 2/2S and Pro
|
|https://github.com/kofec/domoticz-AirPurifier
|-
|Airsend
|for AirSend (<nowiki>https://devmel.com/</nowiki>) devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39590 link]
|https://github.com/FlyingDomotic/domoticz-airsend-plugin/
|-
|Airzone
|Manage AirZone system via local REST API (No Cloud)
|
|https://github.com/Elwinmage/AirZone
|-
|Alarm System
|Ccreate an Alarm System in Domoticz
|
|https://github.com/Beastie971/Domoticz-Alarm
|-
|alphaESS Battery
|
|
|https://github.com/AntoineVDH/alphaESS-battery-plugin
|-
|Android TV
|
|
|https://github.com/enesbcs/domo-androidtv
|-
|APC UPS
|
|
|https://github.com/jgaalen/domoticz-apc-ups-plugin
|-
|Atrea
|Atrea ventilation with heat recuperation
|
|https://github.com/mar-svo/atrea
|-
|AWTRIX3
|AWTRIX3 Smart Pixel Clock
|[https://forum.domoticz.com/viewtopic.php?t=42930 Link]
|https://github.com/galadril/Domoticz-AWTRIX3-Plugin
|-
|Balboa Spa
|Balboa Spa Hot Tub.
|
|https://github.com/Swedlund/Balboa-Spa-plugin-for-Domoticz
|-
|Battery monitoring for Z-Wave nodes
|ZWave Devices Battery Monitoring
|
|[[Plugins/BatteryLevel.html]]
|-
|Bluetooth Beacon Presence
|
|
| [https: / github.com mrin domoticz-bt-presence |https://github.com/mrin/domoticz-bt-presence
|-
|Bluetooth Presence
|detect if a given bluetooth MAC address is within reach
|
|https://github.com/mvdklip/Domoticz-Bluetooth-Presence
|-
|Bluetooth MAC Ping
|
|
| [https: / github.com heggink domoticz-bluetooth-ping |https://github.com/heggink/domoticz-bluetooth-ping
|-
|Bluetti
|Bluetti power stations via Bluetooth
|[https://forum.domoticz.com/viewtopic.php?f=65&t=43783 link]
|https://github.com/lemassykoi/Domoticz-Bluetti-Plugin
|-
|BMW Connected Drive
|
|
|https://github.com/FilipDem/Domoticz-BMW-plugin
|-
|Bosch EasyControl
|Bosch Easycontrol CT200 Thermostat
|[https://www.domoticz.com/forum/viewtopic.php?p=298944 link]
|https://github.com/ggraat/domoticz-easycontrol-plugin
|-
|Botvac (Neato) Vacuum
|
|
|https://github.com/gilmrt/Domoticz-Botvac-Plugin
|-
|Brel Home Hub
|
|
|https://github.com/superjunky/Domoticz-Brel-Plugin
|-
|Broadlink IR Remote
|Broadlink MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
|[https://www.domoticz.com/forum/viewtopic.php?t=33223 Link]
|https://github.com/zak-45/Broadlink-Domoticz-plugin
|-
|Broadlink Universal IR Remote Controller
|Broadlink RM2 Pro/Plus, RM Mini3
|
|https://github.com/Whilser/Broadlink-RM2-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Buienradar.nl (Weather lookup)
|Buienradar Weather Lookup
|
| [https: / github.com ffes domoticz-buienradar |https://github.com/ffes/domoticz-buienradar
|-
|Climacell Weather and Air quality
|
|
|https://github.com/afer92/domotiz-plugin-climacellV4
|-
|Creasol DomBus
|Modules designed for Domoticz with analog and digital inputs, pulsed counters, NTC temperature inputs, relays outputs, temperature humidity and touch sensors. Also, EVSE module for EV charging and one dual axis sun tracker controller.
|[https://www.creasol.it/domotics link]
|https://github.com/CreasolTech/CreasolDomBus
|-
|Crow Runner Alarm
|Crow/AAP Alarm IP Module
|
| [https: / github.com febalci DomoticzCrowAlarm |https://github.com/febalci/DomoticzCrowAlarm
|-
|Cupra cars
|Cupra EV cars
|
|https://github.com/jgaalen/domoticz-cupra-plugin
|-
|Dahua VTO Dz
|Dahua VTO doorbell
|
|https://github.com/rbrouwer/dahua-vto-dz
|-
|Daikin Airconditioning (BRP069A42)
|Daikin BRP069A42 WiFi adapter
|
| ''[https: / github.com leejoow domoticz_daikin_BRP069A42 |https://github.com/leejoow/domoticz_daikin_BRP069A42
|-
|DDS238 ZN/S energy meter
|Modbus RTU (serial port): 1 or more devices can be attached to the same RS485 bus
|
|https://github.com/CreasolTech/domoticz-dds238
|-
|DDS238-2 ZN/S Modbus over TCP
|Hikking and compatible
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36335 link]
|https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp
|-
|DTS238-7-modbus
|DS238-7 3 phase electric power meter with RS485 modbus
|
|https://github.com/voyo/DDS238-7-modbus
|-
|deCONZ bridge (For Conbee,Raspbee)
|
|
| [https: / github.com Smanar Domoticz-deCONZ |https://github.com/Smanar/Domoticz-deCONZ
|-
|Denon/Marantz Amplifier
|
|
| [https: / github.com dnpwwo Domoticz-Denon-Plugin |https://github.com/dnpwwo/Domoticz-Denon-Plugin
|-
|DevmelAirSend
|AirSend and Airsend Duo (<nowiki>https://devmel.com/</nowiki>)
|
|https://github.com/ultrasuperpingu/DomoticzDevmelAirsend
|-
|Dexcom Share API
|
|
|https://github.com/MSe-5-14/Domoticz-Dexcom-API/
|-
|Dingtian Relay
|Dingtian Relay Controller
|
|https://github.com/dtlzp/Domoticz-Dingtian-Relay-Plugin
|-
|domoticz-storm-report (burze.dzis.net)
|Storm Reporting (Europe)
|
| [https: / github.com lrybak domoticz-storm-report |https://github.com/lrybak/domoticz-storm-report
|-
|DSC EnvisaLink
|DSC EnvisaLink Alarm Interface
|
| [https: / github.com dnpwwo Domoticz-DSCEnvisalink-Plugin |https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
|-
|DWD WeatherAlarm
|German weather alarm
|
|https://github.com/belzetrigger/domoticz-DWDWeatherAlarm
|-
|Dyson Pure Link
|
|
|https://github.com/JanJaapKo/DysonPureLink
|-
|ebusd bridge
|for e.g. Vaillant and Saunier-Duval boilers
|
| [https: / github.com guillaumezin DomoticzEbusd |https://github.com/guillaumezin/DomoticzEbusd
|-
|Elprisetjustnu
|fetch Swedish energy prices from Elpriset just nu.se
|
|https://github.com/j-b-n/sweden_energyprice
|-
|Emmeti Mirai SMI heat pump
|Manages main parameter for Emmeti heat pumps
|[https://www.creasol.it/en/support/domotics-home-automation-and-diy/controlling-heat-pump-to-maximize-power-consumption-from-photovoltaic link]
|https://github.com/CreasolTech/domoticz-emmeti-mirai
|-
|EMS bus Wi-Fi Gateway (EMS-ESP/Nefit/Proddy)
|
|
|https://github.com/bbqkees/ems-esp-domoticz-plugin
|-
|Enigma2
|to control Enigma2 tuner
|[https://forum.domoticz.com/viewtopic.php?t=21047 link]
|https://github.com/kofec/Domoticz-Enigma2
|-
|eQ-3 MAX!
|ELV/EQ-3 MAX! Python plugin
|
|https://github.com/mvzut/maxcube-Domoticz-plugin
|-
|ESP8266 Milight hub
|
|
|https://github.com/etsach/espmilighthub-domoticz
|-
|EspNow Serial
|
|
|https://github.com/FlyingDomotic/domoticz-espnowserial-plugin
|-
|EVCC-IO
|monitor and control your EV charging setup via EVCC
|
|https://github.com/galadril/Domoticz-EVCC-IO-Plugin
|-
|Ewpe Smart Air Conditioners via MQTT
|(Gree Smart/TOSOT)
|
| [https: / github.com stas-demydiuk domoticz-ewpe-smart-mqtt-plugin |https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
|-
|Freebox
|
|
| [https: / github.com supermat PluginDomoticzFreebox |https://github.com/supermat/PluginDomoticzFreebox
|-
|Frisquet-Connect
|For Frisquet Connect Boiler control
|[https://forum.domoticz.com/viewtopic.php?t=44201 link]
|https://github.com/Krakinou/FrisquetConnectDomoticz
|-
|Fritz Presence
|
|
|https://github.com/belzetrigger/domoticz-FritzPresence
|-
|FroniusHTTP
|Fronius Solar inverter
|
|https://github.com/ayasystems/froniusHttp
|-
|Fujitsu-AC
|Fujitsu Airconditioning
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36402 link]
|https://github.com/593304/Domoticz-Fujitsu-AC
|-
|GlobalCache GC-100
|
|
|https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin
|-
|GoodWe solar inverter via SEMS API
|
|
| [https: / github.com dylian94 domoticz-GoodWeSEMS |<s>https://github.com/dylian94/domoticz-GoodWeSEMS</s>
https://github.com/janjaapko/domoticz-GoodWeSEMS
|-
|GoodWe Modbus UDP
|GoodWe inverters over LAN or WLAN via UDP that supports Modbus
|
|https://github.com/remco-k/domoticz-goodwe-modbusudp-plugin
|-
|Goodwe RS485
|Goodwe Solar Inverters via RS485/modbus
|
|https://github.com/nijmeijer/goodwe_rs485_domoticz
|-
|Google Home & Chromecast
|
|
| [https: / github.com dnpwwo Domoticz-Google-Plugin |https://github.com/dnpwwo/Domoticz-Google-Plugin
|-
|Google Nest and Protect
|Nest thermostats and Nest Protect devices
|
|https://github.com/FilipDem/Domoticz-NEST-plugin
|-
|Govee
|Govee lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=39875 link]
|https://github.com/galadril/Domoticz-Govee-Plugin
|-
|Growatt Inverter
|Growatt Inverter via APP Webservice
|
| [https: / github.com sincze Domoticz-Growatt-Webserver-Plugin |https://github.com/sincze/Domoticz-Growatt-Webserver-Plugin
|-
|GPSLogger
|Location and presence detection
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=42045 link]
|https://github.com/TurnOfAFriendlyCard/Domoticz-GPSLogger-Plugin
|-
|H801 LED WiFi controller Plugin
|H801 LED WiFi controller with Tasmota firmware
|
| [https: / github.com stas-demydiuk domoticz-h801-tasmota-plugin |https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
|-
|Hewalex
|Hewalex heat and solar pumps
|
|https://github.com/mvdklip/Domoticz-Hewalex
|-
|Hive Plugin
|Hive Active Heating
|
| [https: / github.com imcfarla2003 domoticz-hive |https://github.com/imcfarla2003/domoticz-hive
|-
|Home Connect
|Bosch/Siemens/Neff/Balay appliances
|
|https://github.com/domoticz/home-connect
|-
|Homewizard
|
|
| [https: / github.com rvdvoorde domoticz-homewizard |https://github.com/rvdvoorde/domoticz-homewizard
|-
|HomeWizard Battery
|
|
|https://github.com/etmmvdp/HomeWizard-Battery-plugin
|-
|HomeWizard Wifi P1 Meter
|HomeWizard Wifi P1 meter
|
|https://github.com/Eraser3/HomeWizard-Wifi-p1-plugin
|-
|HomeWizard Wifi Watermeter
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Watermeter
|-
|HomeWizard Wifi Energy Socket
|
|
|https://github.com/Eraser3/HomeWizard-Wifi-Energy-Socket
|-
|HomekitInsecureClient
|control Homekit Insecure Clients from Domoticz
|[https://domoticz.com/forum/viewtopic.php?f=65&t=36148 link]
|https://github.com/macjl/Domoticz-HomekitInsecureClient
|-
|Hosola / Omnik solar inverter
|
|
| [https: / github.com ericstaal domoticz tree master plugin hosola |https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
|-
|Husqvarna automower
|
|[https://www.domoticz.com/forum/viewtopic.php?t=39624 link]
|https://github.com/FilipDem/Domoticz-Husqvarna-Automower-plugin
|-
|Huawei-Inverter
|Huawei-Inverter over Modbus TCP
|[https://forum.domoticz.com/viewtopic.php?t=43064 link]
|https://github.com/JWGracht/Domoticz-Huawei-Inverter
|-
|Hyperion
|
|
| [https: / github.com ericstaal domoticz blob master plugin hyperion |https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
|-
|Hyundai Kia connect
|Monitor and control connected cars by Hyunday and Kia
|[[Vehicles Hyundai Kia|link]]
|https://github.com/CreasolTech/domoticz-hyundai-kia
|-
|iCloud device locator
|
|
| [https: / github.com heggink domoticz-icloud |https://github.com/heggink/domoticz-icloud
|-
|iDetect Presence detection
|
|
|https://github.com/d-EScape/Domoticz_iDetect
|-
|IHC (Intelligent House Control)
|Schneider / LK IHC (all generations)
|[https://www.domoticz.com/forum/viewtopic.php?t=42531 link]
|https://github.com/kjlisby/domoticz-ihc-plugin
|-
|IKEA Tradfri
|Trådfri Gateway (Ikea)
|
| [https: / github.com moroen IKEA-Tradfri-plugin |https://github.com/moroen/IKEA-Tradfri-plugin
|-
|IntesisBox / IntesisHome
|IntesisBox WMP-1 Protocol
|
|https://github.com/luismalddonado/IntesishomewithDomoticz
|-
|IOplus relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.ioplus
|-
|IR Climate Controller
|Tasmota IR climate controller integration
|[https://forum.domoticz.com/viewtopic.php?t=43979 link]
|https://github.com/szelessavalapitvany/domoticz-ir-climate-controller
|-
|Itho Wifi
|
|[https://forum.domoticz.com/viewtopic.php?t=35383 link]
|https://github.com/galadril/Domoticz-Itho-Wifi-Plugin
|-
|Kesser
|For Clima/ of brand Kesser with WiFi Tuya
|
|https://github.com/jmichault/kesser
|-
|Jablotron SIA Alarm
|
|
|https://github.com/andyboeh/domoticz-jablotron
|-
|KinCony KC868 Smart Controller
|KC868 Wifi Relay Controller
|
|https://github.com/hzkincony/Domoticz-KinCony-KC868-Ethernet-WiFi-Relay-Module-Plugin
|-
|KNMI weather
|
|
|https://github.com/bramvreugd/Domoticz-KNMI-Weather-Plugin
|-
|Kodi Players
|Kodi
|
| [https: / github.com dnpwwo Domoticz-Kodi-Plugin |https://github.com/dnpwwo/Domoticz-Kodi-Plugin
|-
|Ledenet / Ufolight RGB controller
|
|
|https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V1
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/olinek2/LGAC_SmartT
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=26940 link]
|https://github.com/majki09/domoticz_lg_thinq_plugin
|-
|LG Smart AC (SmartThinQ)
|LG Smart AC devices Api V2 using Personal Access Token (PAT)
|[https://forum.domoticz.com/viewtopic.php?t=44600 link]
|https://github.com/avriessen/domoticz_lg_thinqconnect_plugin
|-
|LGTV WebOS
|
|
|https://github.com/GameDevHobby/Domoticz-LGTV-WebOS-Plugin
|-
|<s>Life 360 Presence</s>
|<s>Life 360 Presence Detection</s>
|
| [https: / github.com febalci DomoticzLife360 |No longer available, use GPSLogger plugin
|-
|Linky
|
|
| [https: / github.com guillaumezin DomoticzLinky |https://github.com/guillaumezin/DomoticzLinky
|-
|LinkyStdMode
|Linky Standard mode
|
|https://github.com/bnj-04/LinkyStdMode
|-
|Link-Tap
|Link-Tap watering timer
|
|https://github.com/DebugBill/Link-Tap
|-
|Luxtronic2
|Heatpump controller (AlphaInnotec)
|[https://domoticz.com/forum/viewtopic.php?p=282425#p282425 link]
|https://github.com/ajarzyn/domoticz-luxtronic2
|-
|Luxtronik
|Luxtronik Heat Pump Controller
|[https://forum.domoticz.com/viewtopic.php?t=44176 link]
|https://github.com/Rouzax/luxtronik-domoticz-plugin-v2
|-
|Lyrion Music Server
|formaly known as Logitech Media Server
|[https://forum.domoticz.com/viewtopic.php?p=329633 link]
|https://github.com/MadPatrick/domoticz_Lyrion
|-
|Marstek
|Marstek CT Smart Meter
|
|https://github.com/Haaibaai/Domoticz-Marstek
|-
|Marstek Modbus
|Marstek Venus V3 home battery over Modbus
|
|https://github.com/hopSilentSimon/Domoticz_Marstek_Modbus
|-
|Mattericz
|Matter integraion with Open Home Foundation Matter Server
|[https://forum.domoticz.com/viewtopic.php?p=332498#p332498 link]
|https://github.com/fleinze/Mattericz
|-
|MBusSerial
|
|
|https://github.com/Net-time/MBusSerial
|-
|MegaIO relay board
|
|
|https://github.com/josefpavlik/domoticz.plugin.megaio
|-
|MELCloud
|Control Mitsubishi AC
|
|[https://github.com/gysmo38/domoticz-python-melcloud
|-
|Meteo Alarm EU RSS Reader
|
|
| [https: / github.com ycahome MeteoAlarmEU |https://github.com/ycahome/MeteoAlarmEU
|-
|Midea Dehum
|Midea Dehumidifier
|
|https://github.com/meaninglessvanity/midea_dehum_plugin
|-
|Mikrotik RouterOS
|
|
| [https: / github.com mrin domoticz-routeros-plugin |https://github.com/mrin/domoticz-routeros-plugin
|-
|Mitsubishi AC MQTT interface
|AC control with Swicago's serial and MQTT interface
|
|[https://github.com/Masurov/Domoticz-MitsubishiHpMQTT-Plugin
|-
|Modbus RTU / ASCII / TCP/IP
|
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=21297 Link]
|https://github.com/DomoticX/domoticz-modbus
|-
|Moon Phases
|
|
| [https: / github.com ycahome MoonPhases |https://github.com/ycahome/MoonPhases
|-
|Moonraker
|Moonraker/Klipper 3D-printers
|[https://forum.domoticz.com/viewtopic.php?t=43869 Link]
|https://github.com/klym-tatarnikov/MoonrakerDomoticz/
|-
|Motherboard PSUtil Sensors
|
|
| [https: / github.com febalci DomoticzPsutil |https://github.com/febalci/DomoticzPsutil
|-
|MQTT discovery
|MQTT Discovery plugin with Sonoff-Tasmota extensions
|[https://www.domoticz.com/forum/viewtopic.php?t=21918 link]
| [https: / github.com emontnemery domoticz_mqtt_discovery |https://github.com/emontnemery/domoticz_mqtt_discovery
|-
|MQTT Mapper
|Map MQTT messages to Domoticz devices
|[https://www.domoticz.com/forum/viewtopic.php?t=39279 link]
|https://github.com/FlyingDomotic/domoticz-mqttmapper-plugin
|-
|Myenergi
|Myenergi Zappi EV charger
|
|https://github.com/mvdklip/Domoticz-myenergi
|-
|NIBE Uplink
|
|
|https://github.com/flopp999/NIBEUplink-Domoticz
|-
|Niko Home Control
|
|
|https://github.com/tnys/nikohomecontrol-domoticz
|-
|Nissan Leaf
|EV
|[https://www.domoticz.com/forum/viewtopic.php?t=36634 link]
|https://github.com/BreizhCat/DomoticzNissanLeaf
|-
|NUKI Locks
|
|
| [https: / github.com heggink domoticz-nuki |https://github.com/heggink/domoticz-nuki
|-
|N8N
|Integrate N8N workflow AI automations directly into Domoticz.
|
|https://github.com/galadril/Domoticz-N8N-Plugin
|-
|OctoPrint
|
|
|https://github.com/jneilliii/OctoPrint-Domoticz
|-
|Omnik Inverter Local
|Omnik Inverter via Local device
|
|https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin
|-
|OM-310 Power Limiter
|OM-310 Power Limiter (Novatek-Elektro) over Modbus TCP
|
|https://github.com/tmrealive/OM310-Domoticz-plugin
|-
|Onkyo AV Receiver
|Onkyo receivers
|
| [https: / github.com jorgh6 domoticz-onkyo-plugin |https://github.com/jorgh6/domoticz-onkyo-plugin
|-
|OpenAQ
|Air Quality
|[https://www.domoticz.com/forum/viewtopic.php?t=22092 link]
|https://github.com/waltervl/Domoticz-OpenAQ-Plugin
|-
|OpenEVSEPlugin
|OpenEVSE mqtt
|
|https://github.com/ayasystems/OpenEVSEPlugin
|-
|OpenDTU
|collects solar production data from an OpenDTU unit without requiring MQTT
|
|https://github.com/lemassykoi/Domoticz-OpenDTU-Plugin
|-
|Ouman-C203-Modbus
|
|
|https://github.com/pawelmuszynski/domoticz-Ouman-C203-Modbus
|-
|IntesisBox-Panasonic
|IntesisBox Panasonic-Tcap over modbus
|
|https://github.com/voyo/IntesisBox-Panasonic-Tcap-modbus
|-
|Panasonic Cloud Comfort
|Panasonic Cloud Comfort through CZ-TACG1 WiFi adapter
|
|https://github.com/sdamasoc/domoticz_panasonic_CZ-TACG1/
|-
|Paradox Alarm PRT3 serial interface
|Domoticz-ParadoxPrt3-Plugin
|
| [https: / github.com Masurov Domoticz-ParadoxPrt3-Plugin |https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
|-
|Parrot Flower Power & Pot plugin
|
|
| [https: / github.com tazounet parrot_flower_plugin |https://github.com/tazounet/parrot_flower_plugin
|-
|Pi Clock Speeds
|Reimplements clockspeeds (after removal from 2024.1)
|
|[https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin https://github.com/akamming/Domoticz_pi_Clockspeeds_Plugin: Domoticz_pi_clockspeeds_plugin]
|-
|RPI GPIO
|Universal GPIO control plugin for Domoticz on Raspberry Pi.
|
|https://github.com/Mibeus/Domoticz-GPIO-Debian-13
|-
|Pinger (ICMP)
|Pinger
|
| [https: / github.com dnpwwo Domoticz-Pinger-Plugin |https://github.com/dnpwwo/Domoticz-Pinger-Plugin
|-
|Pioneer AVR
|
|
| [https: / github.com febalci DomoticzPioneerAVR |https://github.com/febalci/DomoticzPioneerAVR
|-
|Powerview
|Hunter Douglas shades
|
|https://github.com/jgaalen/domoticz-powerview-plugin
|-
|Powerworld
|PowerWorld R290 heat pumps by modbus connection
|
|https://github.com/Mike19700/domoticz-PowerWorld-heat-pump
|-
|pyViCare
|Viessmann API for eg Vitovalor PT2
|
|https://github.com/wimmme/pyViCare-domoticz
|-
|PZEM-004T
|PZEM-004T energy meter
|
|https://github.com/mce35/Domoticz-PZEM-004T
|-
|PZEM-016
|PZEM-016, PZEM-014 and PZEM-004T energy meters: supports up to 51 meters on the same bus
|
|https://github.com/CreasolTech/domoticz-pzem-016
|-
|PZEM-017 Modbus
|PZEM Energy Monitor
|
|https://github.com/mar-svo/PZEM-017
|-
|RAVEn Zigbee energy monitor
|RAVEn Power Monitor
|
| [https: / github.com dnpwwo Domoticz-RAVEn-Plugin |https://github.com/dnpwwo/Domoticz-RAVEn-Plugin
|-
|Remeha Home
|Remeha thermostats
|[https://www.domoticz.com/forum/viewtopic.php?p=310952#p310952 link]
|https://github.com/tuk90/RemehaHome-Domoticz
|-
|Renault EV
|for the My Renault API
|[https://www.domoticz.com/forum/viewtopic.php?t=40788 Link]
|https://github.com/HomeACcessoryKid/Domoticz-Renault-Plugin
|-
|Renault-Dacia
|Renault Dacia Electric Vehicle
|
|https://github.com/Kask29/Domoticz-Renault-Dacia-Plugin
|-
|Reolink
|Reolink Cameras Doorbells
|
|https://github.com/j-b-n/domoticz_reolink
|-
|Resol-VBUS
|
|
|https://github.com/bramvreugd/Domoticz-Resol-VBUS-Plugin
|-
|RFSwitches
|RF 433 Switches
|
| [https: / github.com flatsiedatsie 433Switches |https://github.com/flatsiedatsie/433Switches
|-
|Rooted Toon
|rooted Toon thermostat
|[https://forum.domoticz.com/viewtopic.php?p=296916#p296916 link]
|https://github.com/MadPatrick/domoticz_toon
|-
|Qlima Wifi airconditioner
|Midea/Inventor AC Clone
|
|https://github.com/awalsum/Qlima
|-
|Quatt
|Quatt Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=40463 link]
|https://github.com/galadril/Domoticz-Quatt-Plugin
|-
|SAIC iSmart
|MG EV Cars
|[https://forum.domoticz.com/viewtopic.php?t=43909 link]
|https://github.com/lemassykoi/Domoticz-MG-Plugin
|-
|Samsung SmartThings Washer
|Retrieve and display the status of a Samsung washing machine via the SmartThings Cloud API.
|
|https://github.com/csutihu/Domoticz-plugin-for-samsung-washing-machine
|-
|SDM120-Modbus
|Eastron SDM120-Modbus RTU Single Phase kWh Meter
|
|https://github.com/simat-git/SDM120-Modbus
|-
|SDM630-Modbus
|Eastron SDM-72 SDM-72v2 SDM-120 SDM-230 SDM-630 kWh meters
|
|https://github.com/gizmocuz/SDM630-Modbus
|-
|Sessy Battery
|
|[https://forum.domoticz.com/viewtopic.php?t=42865 link]
|https://github.com/JanJaapKo/SessyBattery
|-
|Shelly Cloud
|
|
|https://github.com/mario-peters/ShellyCloudPlugin
|-
|Shelly MQTT
|
|
|https://github.com/enesbcs/Shelly_MQTT
|-
|Shelly1 with temp sensors
|
|
|https://github.com/Net-time/Domoticz_Shelly_Plugin
|-
|SMA Inverters
|SMA Solar Inverters using Modbus TCP/IP
|[https://www.domoticz.com/forum/viewtopic.php?t=31457 link]
|https://github.com/derenback/Domoticz-SMA-Inverter
|-
|Smart Virtual Thermostat
|
|
|[[Plugins/Smart_Virtual_Thermostat.html]]
|-
|SNMP Reader
|
|
| [https: / github.com ycahome SNMPreader |https://github.com/ycahome/SNMPreader
|-
|Snapcast
|Snapcast integration (control volume/muting of snapcast clients)
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=38724 link]
|https://github.com/akamming/domoticz-snapcast
|-
|SolarEdge Modbus TCP
|
|
|https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin
|-
|Solax Inverter
|
|
|https://github.com/syrhus/solax_inverter
|-
|Somfy
|Somfy Tahoma / Connexoon
|[https://forum.domoticz.com/viewtopic.php?p=294003#p294003 link]
|https://github.com/MadPatrick/domoticz_somfy
|-
|Sonos
|
|
|https://github.com/gerard33/sonos
|-
|Sony Bravia TV (with Kodi remote)
|Sony Bravia TV
|
| [https: / github.com gerard33 sony-bravia |https://github.com/gerard33/sony-bravia
|-
|SPRSUN-Modbus
|SPRSUN-Modbus Heat Pump
|[https://www.domoticz.com/forum/viewtopic.php?t=41133 link]
|https://github.com/Sateetje/SPRSUN-Modbus
|-
|Steam status
|monitor your Steam status
|[https://forum.domoticz.com/viewtopic.php?t=43033 link]
|https://github.com/galadril/Domoticz-Steam-Plugin
|-
|Stromer EBikes
|
|Link
|https://github.com/elnkosc/stromer_domoticz_plugin
|-
|Synology SurveillanceStation
|
|
| [https: / github.com lolautruche SurveillanceStationDomoticz |https://github.com/lolautruche/SurveillanceStationDomoticz
|-
|SYSFS-Switches
|GPIO SYSFS Switches
|
| [https: / github.com flatsiedatsie GPIO-SYSFS-Switches |https://github.com/flatsiedatsie/GPIO-SYSFS-Switches
|-
|Tapo TP-Link
|Tapo P100 and Tapo P110 smart plug
|
|https://github.com/Chouteau49/Domoticz_Tapo_TP-Link
|-
|Tasmoticz
|autodetecting ESP8266 devices with Tasmota firmware
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=29114 link]
|https://github.com/joba-1/Tasmoticz
|-
|Tesy Modeco Boiler
|Supports local API for Tesy Modeco boilers
|
|https://github.com/heggink/domoticz-tesy
|-
|Thermostat weekly Timer
|
|
|https://github.com/ArtBern/Scheduler
|-
|Thermostate
|ESP thermostat with weather dependent heating control
|
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|ThesslaGreen
|ThesslaGreen recuperators with RS485 modbus interface
|[https://www.domoticz.com/forum/viewtopic.php?p=294570 link]
|https://github.com/voyo/ThesslaGreen-modbus
|-
|Tibber
|Energy prices
|
|https://github.com/flopp999/Tibber-Domoticz
|-
|Tile
|collects the distance from your home to your Tile devices
|
|https://github.com/sydspost/Domoticz-Tile-plugin
|-
|tinycontrol
|LAN IOT controller
|
|https://github.com/kofec/domoticz-tinycontrol
|-
|TinyTUYA-Local
|Controls TUYA devices on your local network.
|
|https://github.com/Xenomes/Domoticz-TinyTUYA-Local-Plugin
|-
|ToonMonitor
|to monitor a Toon Thermostat
|
|https://github.com/JackV2020/Domoticz-ToonMonitor
|-
|Toyota
|for a Toyota car with connected services
|
|https://github.com/joro75/Domoticz-Toyota-Plugin
|-
|TP-Link-smartplug
|TP-Link smartplug HS100 / HS110 / HS110v2 (european version)
|
| [https: / github.com lordzurp domoticz-tplink-smartplug |https://github.com/lordzurp/domoticz-tplink-smartplug
|-
|TP-Link Tapo plug
|Tp-link Tapo P100 plugs, P105 plugs and L510E bulbs (on/off)
|[https://domoticz.com/forum/viewtopic.php?f=56&t=32774 link]
|https://github.com/593304/Domoticz-Tapo
|-
|Trafikverket API Weather
|
|
|https://github.com/Net-time/Domoticz_Trafikverket_Plugin
|-
|Domoticz Tuya Cloud API Plugin
|
|
|https://github.com/lacha07/domoticz-tuya-cloud
|-
|Tuya-Powerplug
|
|
| [https: / github.com sincze Domoticz-Tuya-SmartPlug-Plugin |https://github.com/sincze/Domoticz-Tuya-SmartPlug-Plugin
|-
|Tuya Plugin
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/Xenomes/Domoticz-TUYA-Plugin
|-
|Tuya
|Controls TUYA devices your network (mainly on/off switches and Lights)
|
|https://github.com/guino/tuyaha
|-
|PC321-TY Tuya
|Plugin for the Wifi version PC321-TY 3 phase power clamp
|
|https://github.com/nlovrens/PC321_TY_tuya_local
|-
|Unifi Presence
|
|
|https://github.com/Wizzard72/Domoticz-Unifi-Presence
|-
|UniPi EVOK
|
|
|https://github.com/mccwdev/domoticz-unipi
|-
|UPS Monitor
|
|
|[[Plugins/NUT_UPS.html]]
|-
|Venta
|for venta device (LPH60 WiFi App Control)
|
|https://github.com/ajarzyn/domoticz-venta
|-
|Victron Energy
|Victron Energy GX
|
|https://github.com/xbeaudouin/victron-energy-domoticz
|-
|VictronMultiplusII
|Victron Multiplus-II Inverter
|
|https://github.com/pawcio50501/domoticz-VictronMultiplusII
|-
|VirtualThermostat-PID
|
|
|https://github.com/worops/Domoticz-VirtualThermostat-PID
|-
|Volumio
|control Volumio music player
|
|https://github.com/frepkovsky/Domoticz-Volumio-Plugin
|-
|Volvo
|All Volvo cars as of model year 2015
|[https://domoticz.com/forum/viewtopic.php?p=299165 link]
|https://github.com/akamming/Domoticz_VolvoRecharge_Plugin
|-
|Wallbox
|Wallbox EV charger
|[https://www.domoticz.com/forum/viewtopic.php?t=40203 link]
|https://github.com/lokonli/domoticz-wallbox
|-
|WAN IP Checker
|
|
| [https: / github.com ycahome WAN-IP-CHECKER |https://github.com/ycahome/WAN-IP-CHECKER
|-
|Watermeter NPN Plugin
|
|
| [https: / github.com akamming domoticz-watermeter |https://github.com/akamming/domoticz-watermeter
|-
|We-Connect
|Read Volkswagen ID.3 battery percentage and distance left
|[https://forum.domoticz.com/viewtopic.php?t=42840 link]
|https://github.com/Andreotti100/We-connect
|-
|Weather Dependent Heating Control
|OpenTherm weather dependent heating control
|[https://domoticz.com/forum/viewtopic.php?p=275450#p275450 link]
|https://github.com/akamming/Domoticz_Thermostate_Plugin
|-
|WeHeat
|WeHeat heatpump
|[https://forum.domoticz.com/viewtopic.php?t=44068 link]
|https://github.com/Tableflipper9001/weheat-domoticz-plugin
|-
|Wellbeing
|Electrolux / AEG Wellbeing Air Purifiers
|
|https://github.com/jgaalen/domoticz-wellbeing-plugin
|-
|Wiz Connected
|Wiz wifi lights
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=36724 link]
|https://github.com/sydspost/Domoticz-WiZ-connected-plugin
|-
|WU Direct
|WuDirect interface for Personal Weather Stations
|[https://domoticz.com/forum/viewtopic.php?p=276040#p276040 link]
|https://github.com/vaneeten/domoticz-wudirect
|-
|WT53R Rain Tank Sensor
|connects to a WT53R range sensor over Modbus TCP protocol
|
|https://github.com/voyo/Domoticz_WT53R_Rain_Tank_Sensor
|-
|Xiaomi Mi Flower Mate
|Xiaomi Mi Flower Mates and other BT Flower mate or Flower care
|[https://www.domoticz.com/forum/viewtopic.php?f=65&t=22281 liink]
| [https: / github.com flatsiedatsie Mi_Flower_mate_plugin |https://github.com/flatsiedatsie/Mi_Flower_mate_plugin
|-
|Xiaomi Mi Robot Vacuum
|
|
| [https: / github.com mrin domoticz-mirobot-plugin |https://github.com/mrin/domoticz-mirobot-plugin
|-
|Xiaomi PM2.5 Sensor
|Xiaomi PM2.5 Air Quality Sensor
|
| https: / github.com febalci DomoticzXiaomiPM2.5 |https://github.com/febalci/DomoticzXiaomiPM2.5
|-
|Xiaomi Universal IR Remote Controller
|Xiaomi Chuangmi IR
|
|https://github.com/Whilser/Xiaomi-Universal-IR-Remote-Controller-Domoticz-plugin
|-
|Xiaomi MiJia Philips LED Lamp
|Xiaomi MiJia Philips Bulb, ZhiRui, ZhiYi, etc. LED lamps
|
|https://github.com/Whilser/Xiaomi-MiJia-Philips-LED-Lamp
|-
|Xtend
|plugin for collection of data from an Intergas Xtend heatpump unit.
|
|https://github.com/WillemD61/XTEND-plugin
|-
|Yamaha AV Receiver
|
|
| [https: / github.com thomas-villagers domoticz-yamaha |https://github.com/thomas-villagers/domoticz-yamaha
|-
|YI-Hack
|
|
| [https: / github.com galadril Domoticz-Yi-Hack-Plugin |https://github.com/galadril/Domoticz-Yi-Hack-Plugin
|-
|ZigbeeforDomoticz
|Zigate, Zigpy, TI CC2531, CC13x2, CC26x2, SiliconLabs, deConz (ConBee, raspBee). No need of mqtt or other middleware/broker.
|[https://www.domoticz.com/forum/viewforum.php?f=68 link]
| [https: / github.com sasu-drooz Domoticz-Zigate |https://github.com/zigbeefordomoticz/Domoticz-Zigbee
|-
|-
|Zigbee MQTT Bridge
|for Tasmota Zigbee Gateway
|[https://forum.domoticz.com/viewtopic.php?p=329186#p329186 link]
|https://github.com/Mibeus/domoticz_zigbee2tasmota
|-
|Zigbee2MQTT plugin
|
|
| [https: / www.zigbee2mqtt.io |https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin
|-
|Zigbee2Tasmoticz
|
|
|https://github.com/fleinze/Zigbee2Tasmoticz
|-
|ZoneMinder
|video surveillance software system
|
|https://github.com/Swedlund/ZoneMinder-plugin-for-Domoticz
|-
|}

'''$''': Requires some pre-requisites to be installed. Check instructions. 
'''$$''': Cannot be integrated. Requires nested repository pull.

===Related Wiki Links===

Some tips on using plugins: [[Using_Python_plugins]] 
Creating a Python plugin: [[Developing_a_Python_plugin]] 
Domoticz not finding Python on Linux: [[Linux#Problems_locating_Python]]
[[Category:Plugins]]

Integrations and Protocols

2026-06-10T08:17:00Z

Walter vl: /* AI Agent */

Domoticz can speak a lot of device languages and connect to many different interfaces. Those devices are in the world of computers techically called "protocols" and computing interfaces are called API (Application Programming Interface).

This page is about helping you summerize languages or 'protocols' which Domoticz can understand, and other ways of helping Domoticz connecting to different devices or other bridges/hubs/gateways/controllers, for example through plugins (addons).

This summery also tries mention a few examples of such devices.

=Plugins (Addons)=
Python Plugins (sometimes also refered to as addons, add-ons, or extensions) expand Domoticz abilties to connect to even more devices, bridges, gateways, hubs, controllers, off-line or online services, and more.

*[[Plugins]] - A list of plugins available. New ones are rapidly being added. Look in the forum under 'python' to find the latest additions.
*[[Using_Python_plugins]] - Details on how to install a plugin.
*[[Developing a Python plugin]] - Details on how to develop your own plugin.

==On your device==
Your Domoticz server might have built-in sensors, or talk to other software on your server.

*[[Adding internal pc sensors to Domoticz on Windows systems|Adding internal PC sensors to Domoticz on Windows systems]]
*[[Write_Domoticz_logfile_to_Synology_Log_Center|Write Domoticz log to Synology Log Center]]
*[[PiFace]] 

==USB==
Plug devices directly into your Domoticz server.

*[[Voltcraft_CO-20 | Voltcraft CO-20 airquality sensor]] 

==Buienradar==
Your own private Buienradar Weatherstation. From Domoticz build V4.11230 and up it is possible to add native Buienradar instead of using plugin

*[[Buienradar | Buienradar native implementation]] 

= AI Agent =
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process at the <code>/mcp</code> endpoint. AI agents can now discover and control devices using the <code>search_devices</code> tool - making Domoticz one of the first home automation platforms with built-in MCP support.

An AI agent can create sensors and devices (<code>create_sensor</code> / <code>create_device</code>), hide or permanently delete them, and read full sensor history through <code>get_sensor_history</code> - daily calendar data for every sensor type plus the event log for switches and scenes. Battery and RSSI/signal levels now appear right in device search, with <code>hw_idx</code> and <code>include_unused</code> filters and resource-URI autocompletion to keep queries precise.

See for more instructions page [[MCP model context protocol LLM]]

= Voice Control =
[[Alexa Smart Home Integration|Alexa]]

=Protocols=
Below you will find a number of protcols, and details about gateways that give access to large groups of devices using those protocols. Gateways are often devices that plug into or communicate with your server, such as a bluetooth dongle or wireless receiver and transmitter.

==IP (Internet Protocol) with TCP/UDP and HTTP==
IP (Internet Protocol) are your everyday network protocols used on local networks and the internet. This is the basic language spoken by all servers and computers on the internet and by devices in your home network, including your WiFi.

===Wired & Wireless===
These are devices that have gotten an IP address on your local network. Your router hands out these IP addresses.

*[[Philips Hue Lights]]
*[[Fritzbox|FRITZ!Box callmonitor]]
*[[Wake-up_On_Lan|Wake-on-LAN (WoL) a PC with Domoticz]]
*[[Sonos|Sonos: different solutions for integrating Sonos within Domoticz]]
*[[Essent|Essent E-Thermostat (ICY)]]
*[[ESP8266 WiFi module]] 

===Web===
These are services on the internet that you connect to through your internet router. Domoticz can talk to all kinds of services on the internet and get or deposit data there, such as the current weather.

*[[HttpLink|Push data from Domoticz to your own server]]
*[[Weather forecast from forecast.io in Domoticz|<s>Weather forecast from forecast.io in Domoticz</s>]] Not functional any more
*[[Virtual weather devices|<s>Virtual weather devices (Weather Underground)</s>]] Not functional anymore
*[[Open Weather Map]] devices
*[[Domoticz and PvOutput.org|Domoticz and PVOutput.org]]
*[[Telegram Bot|Installing Telegram Notification System - Telegram Bot Method]]
*[[Secure_Nginx_Proxy_Setup|x509-Auth w/Nginx for secure remote access.]]
*[[Smappee |Smappee energymonitor in Domoticz]]
*[https://www.npmjs.com/package/corrently4domoticz Corrently - German Green Power Index in Domoticz] (Node JS Package) 

==MQTT==
This standard, that works on top op TCP/IP, has been around for decades, but has been embraced as the Internet of Things (IoT) hype grew. Domoticz supports [[MQTT]], and will listen on the ''domoticz/in'' topic.

Domoticz also supports platforms that use the MQTT HA Auto Discover protocol, see wiki [[MQTT|MQTT Auto discover Gateway]]

 

==LoRa==
For devices that use LoRa radio technology, a [[TTNMQTT]] module is available which retrieves data using MQTT from The Things Network.
 

==Z-Wave==
The Z-Wave protocol propriatory wireless standard created especially for smart devices,

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Z-Wave on consist of several generations where the newer versions are back-wards compatible with the older generation however incoperating older generation devices into can sometimes lower the encryption level used in your network-mesh.

The downside of the Z-Wave protocol being propriatory is means that there are less manufacturers and devices cost more but the upside is that because it is propriatory interoperability between differet manufacturers is much better than more open protocols, so compatibility between devices and gateways/bridges/controllers is almost always better.

*Using [[Zwave-JS-UI]]
*[[Zwave|Setting up Z-Wave]] with OpenZwave (deprecated)

 

==Zigbee==
Zigbee is a suite of IEEE 802.15.4-based protocol standards some of which are designed to be used by smart devices for home automation.

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Zigbee protocol standards are managed by the Zigbee Alliance and they have relativly low royalty fees and allow anyone to manufacturer chips for Zigbee and Zigbee protocol stacks. Official certification of manufacturers devices by the Zigbee Alliance cost more and though it is not requires it is still recommended, which makes it possible for devices to be non cerfified devices to be cheap and certified devices to be relativly inexpensive.

The downside of the Zigbee protocol being loosley controlled by Zigbee Alliance, not even requireing certifications or quality control means that there can be interoperability issues between differet manufacturers, so compatibility between devices and gateways/bridges/controllers can not be garanteed. Because of this is recommended to preferably buy devices that are "Zigbee 3.0" cerfified by the Zigbee Alliance as that should mean that they have been independently tested to at least meet their minimum requirements of follwing the official Zigbee standards.

 

*[[Zigbee#Zigbee support in Domoticz|Options available for connecting to Zigbee devices from Domoticz]] 

== Matter ==
Matter is a new secure, reliable and local standard protocol for smart/IoT devices launched at the end of 2022 by the Connectivity Standards Alliance.

Domoticz has a Matter integration based on matter.js server, see wiki page [[Matter]]

==315 and 433 MHz==
The 433MHz frequency range in Europe and Asia as well as 315 MHz radio frequency range in North America are the wild west radio spectrums of the wireless world because anyone can use it freely without any licences or permissions needed as long as the do not have too stong radios.

Because there are basically no rules all kinds of "cowboy" devices have been built with an equally big amount of different languages (protocol) being spoken.

The frequency range for the "433MHz" spectrum is actually a range from 433.05 MHz to 434.79 MHz with center frequency being 433.92 MHz (which is also the most commonly uses by most of these types of devices in Europe and Asia). The frequency range for the "315MHz" spectrum is actually a range from 315.xx MHz to 315.xx MHz with center frequency being 315.xx MHz (which is also the most commonly uses by most of these types of devices in North America).

Most of the devices in these spectrums do not support tw-way communcation and in most cases the use unencrypted communications, so in theory anyone could listen in on it, or even control your devices. So please don't buy a pacemaker with a 433Mhz remote.

Thanks to gateways/bridges like RFXcom and RFLink which speak and can translate a lot of these languages (protocols), Domoticz can interact with a lof of those type of devices.

 

*[[RFXcom|Setting up RFXCom]]. This is a commercial product, with two versions. Please buy the newer E version.
*[[RFLink|Setting up RFLink]]. This is free (but not open source) software which you can flash on an Arduino Mega.
*[[rtl_433|Setting up rtl_433]]. This is free, open source software which uses a software defined radio USB dongle to receive signals from 433MHz devices (and other frequencies like 868 Mhz are possible too).

 

==868 and 915 MHz==
A lot of more recent hardware that uses Radio Frequencies to communicate do not use the 433 Mhz anymore but the also open 868 Mhz band (including more standardized protocols like Z-Wave, Zigbee, LoRa, etc.).
Not all hardware uses standardized protocols, a lot still uses their own manufacturer proprietary implementation. Like within the 433 Mhz spectrum, you need a transceiver hooked up to Domoticz to send and receive signal to- and from these devices. For example the RTL SDR dongles using the rtl_433 library (which also supports 868 Mhz and other frequencies).

 

==WiFi 2.4 GHz==
This is the same spectrum that the Wifi standard uses, but there are lots of less well known protocols that operate here too. It's also a bit of a wild west.

*[[MySensors|Mysensors.org: connecting with all MySensors-gateways]]
*[https://github.com/mario-peters/ShellyCloudPlugin Shelly Cloud Plugin] that works with many Shelly devices 

==Bluetooth==
A popular short-range wireless standard. The Raspberry Pi, the most popular platform for Domoticz, now has built in Bluetooth.

*[[BTAudio|Bluetooth Audio]] 

==Homekit (Apple)==
This is a protocol created by Apple.

*[[Homekit_Siri | Apple HomeKit with Siri support]] 

==1-wire==
This is a standard for connecting very simple sensors.

*[http://domoticz.com/wiki/1Wire Using 1-Wire with Domoticz] 

==DomBus==
RS485 serial bus protocol operating at 115200bps: with a 4 wires shielded cable it's possible to carry data and 12/24V power supply to all modules.

This protocol is used by [[Creasol_Dombus|Creasol DomBus]] modules.

==X10==
It's an older standard, but it checks out.

*[[X10 with CM11a|X10 devices with a CM11a]]
*[[X10 devices, CM15 Pro|X10 devices with a CM15 Pro]] 

==eHouse TCP/IP & UDP==
eHouse IP Controllers uses:

*- TCP/IP for direct communication (send commands/events) implementing challenge-response algoritm for security.
*- TCP/IP (via Internet / LAN / WiFi) via eHouse PRO server gathering all IP and NON IP controllers statuses.
*- UDP broadcasts for distributing IP controllers status all over LAN/WiFi network without connection to device 

eHouse NON IP Controllers:

*- work under eHouse PRO server supervision, which is a gateway/proxy and all statuses are also broadcasted by UDP.
*- TCP/IP commands directed to eHouse PRO server are resend to NON IP devices.
*[[eHouse]] | [[eHouse Protocol]] | [[eHouse Configuration]] | [[Supported Controllers]]

==Infrared==
IR (I.R. = infrared or infra-red)

*[[eHouse IR]]

==Unsorted==
Please help sort these.

*[[EnOcean]]
*[[S0Meter|S0-pulsecounter]]
*[[Basic Tellstick functionality with Domoticz]]
*[[Limitless/AppLamp_LED|Limitless/AppLamp/Milight RGBW bulbs/led strips]]
*[[Harmony Hub Control]]. Native [[Harmony Hub]](version 1.1956)
*[[Pi-Mote|Using Energenie Pi-mote with Domoticz]]
*[[LIFX|LIFX lightbulbs]]
*[[Wemo|Belkin WeMo]]
*[[MPD_%26_Domoticz|Music Player Daemon (MPD) & Domoticz]]
*[[SMASpot Monitoring in Domoticz]]
*[[Talking Domoticz|Let Domoticz speak to inform you]]

A larger list of devices that Domoticz supports can be found on the [[Hardware|hardware overview page]].

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]
[[Category:Hardware]]
[[Category:Scripting]]

=Continue to the next page of the introduction=

*[[Hardware| Hardware]]

 
[[Category:Plugins]]

Integrations and Protocols

2026-06-10T08:16:44Z

Walter vl: /* AI Agent */

Domoticz can speak a lot of device languages and connect to many different interfaces. Those devices are in the world of computers techically called "protocols" and computing interfaces are called API (Application Programming Interface).

This page is about helping you summerize languages or 'protocols' which Domoticz can understand, and other ways of helping Domoticz connecting to different devices or other bridges/hubs/gateways/controllers, for example through plugins (addons).

This summery also tries mention a few examples of such devices.

=Plugins (Addons)=
Python Plugins (sometimes also refered to as addons, add-ons, or extensions) expand Domoticz abilties to connect to even more devices, bridges, gateways, hubs, controllers, off-line or online services, and more.

*[[Plugins]] - A list of plugins available. New ones are rapidly being added. Look in the forum under 'python' to find the latest additions.
*[[Using_Python_plugins]] - Details on how to install a plugin.
*[[Developing a Python plugin]] - Details on how to develop your own plugin.

==On your device==
Your Domoticz server might have built-in sensors, or talk to other software on your server.

*[[Adding internal pc sensors to Domoticz on Windows systems|Adding internal PC sensors to Domoticz on Windows systems]]
*[[Write_Domoticz_logfile_to_Synology_Log_Center|Write Domoticz log to Synology Log Center]]
*[[PiFace]] 

==USB==
Plug devices directly into your Domoticz server.

*[[Voltcraft_CO-20 | Voltcraft CO-20 airquality sensor]] 

==Buienradar==
Your own private Buienradar Weatherstation. From Domoticz build V4.11230 and up it is possible to add native Buienradar instead of using plugin

*[[Buienradar | Buienradar native implementation]] 

= AI Agent =
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process.

See for more instructions page [[MCP model context protocol LLM]]

= Voice Control =
[[Alexa Smart Home Integration|Alexa]]

=Protocols=
Below you will find a number of protcols, and details about gateways that give access to large groups of devices using those protocols. Gateways are often devices that plug into or communicate with your server, such as a bluetooth dongle or wireless receiver and transmitter.

==IP (Internet Protocol) with TCP/UDP and HTTP==
IP (Internet Protocol) are your everyday network protocols used on local networks and the internet. This is the basic language spoken by all servers and computers on the internet and by devices in your home network, including your WiFi.

===Wired & Wireless===
These are devices that have gotten an IP address on your local network. Your router hands out these IP addresses.

*[[Philips Hue Lights]]
*[[Fritzbox|FRITZ!Box callmonitor]]
*[[Wake-up_On_Lan|Wake-on-LAN (WoL) a PC with Domoticz]]
*[[Sonos|Sonos: different solutions for integrating Sonos within Domoticz]]
*[[Essent|Essent E-Thermostat (ICY)]]
*[[ESP8266 WiFi module]] 

===Web===
These are services on the internet that you connect to through your internet router. Domoticz can talk to all kinds of services on the internet and get or deposit data there, such as the current weather.

*[[HttpLink|Push data from Domoticz to your own server]]
*[[Weather forecast from forecast.io in Domoticz|<s>Weather forecast from forecast.io in Domoticz</s>]] Not functional any more
*[[Virtual weather devices|<s>Virtual weather devices (Weather Underground)</s>]] Not functional anymore
*[[Open Weather Map]] devices
*[[Domoticz and PvOutput.org|Domoticz and PVOutput.org]]
*[[Telegram Bot|Installing Telegram Notification System - Telegram Bot Method]]
*[[Secure_Nginx_Proxy_Setup|x509-Auth w/Nginx for secure remote access.]]
*[[Smappee |Smappee energymonitor in Domoticz]]
*[https://www.npmjs.com/package/corrently4domoticz Corrently - German Green Power Index in Domoticz] (Node JS Package) 

==MQTT==
This standard, that works on top op TCP/IP, has been around for decades, but has been embraced as the Internet of Things (IoT) hype grew. Domoticz supports [[MQTT]], and will listen on the ''domoticz/in'' topic.

Domoticz also supports platforms that use the MQTT HA Auto Discover protocol, see wiki [[MQTT|MQTT Auto discover Gateway]]

 

==LoRa==
For devices that use LoRa radio technology, a [[TTNMQTT]] module is available which retrieves data using MQTT from The Things Network.
 

==Z-Wave==
The Z-Wave protocol propriatory wireless standard created especially for smart devices,

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Z-Wave on consist of several generations where the newer versions are back-wards compatible with the older generation however incoperating older generation devices into can sometimes lower the encryption level used in your network-mesh.

The downside of the Z-Wave protocol being propriatory is means that there are less manufacturers and devices cost more but the upside is that because it is propriatory interoperability between differet manufacturers is much better than more open protocols, so compatibility between devices and gateways/bridges/controllers is almost always better.

*Using [[Zwave-JS-UI]]
*[[Zwave|Setting up Z-Wave]] with OpenZwave (deprecated)

 

==Zigbee==
Zigbee is a suite of IEEE 802.15.4-based protocol standards some of which are designed to be used by smart devices for home automation.

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Zigbee protocol standards are managed by the Zigbee Alliance and they have relativly low royalty fees and allow anyone to manufacturer chips for Zigbee and Zigbee protocol stacks. Official certification of manufacturers devices by the Zigbee Alliance cost more and though it is not requires it is still recommended, which makes it possible for devices to be non cerfified devices to be cheap and certified devices to be relativly inexpensive.

The downside of the Zigbee protocol being loosley controlled by Zigbee Alliance, not even requireing certifications or quality control means that there can be interoperability issues between differet manufacturers, so compatibility between devices and gateways/bridges/controllers can not be garanteed. Because of this is recommended to preferably buy devices that are "Zigbee 3.0" cerfified by the Zigbee Alliance as that should mean that they have been independently tested to at least meet their minimum requirements of follwing the official Zigbee standards.

 

*[[Zigbee#Zigbee support in Domoticz|Options available for connecting to Zigbee devices from Domoticz]] 

== Matter ==
Matter is a new secure, reliable and local standard protocol for smart/IoT devices launched at the end of 2022 by the Connectivity Standards Alliance.

Domoticz has a Matter integration based on matter.js server, see wiki page [[Matter]]

==315 and 433 MHz==
The 433MHz frequency range in Europe and Asia as well as 315 MHz radio frequency range in North America are the wild west radio spectrums of the wireless world because anyone can use it freely without any licences or permissions needed as long as the do not have too stong radios.

Because there are basically no rules all kinds of "cowboy" devices have been built with an equally big amount of different languages (protocol) being spoken.

The frequency range for the "433MHz" spectrum is actually a range from 433.05 MHz to 434.79 MHz with center frequency being 433.92 MHz (which is also the most commonly uses by most of these types of devices in Europe and Asia). The frequency range for the "315MHz" spectrum is actually a range from 315.xx MHz to 315.xx MHz with center frequency being 315.xx MHz (which is also the most commonly uses by most of these types of devices in North America).

Most of the devices in these spectrums do not support tw-way communcation and in most cases the use unencrypted communications, so in theory anyone could listen in on it, or even control your devices. So please don't buy a pacemaker with a 433Mhz remote.

Thanks to gateways/bridges like RFXcom and RFLink which speak and can translate a lot of these languages (protocols), Domoticz can interact with a lof of those type of devices.

 

*[[RFXcom|Setting up RFXCom]]. This is a commercial product, with two versions. Please buy the newer E version.
*[[RFLink|Setting up RFLink]]. This is free (but not open source) software which you can flash on an Arduino Mega.
*[[rtl_433|Setting up rtl_433]]. This is free, open source software which uses a software defined radio USB dongle to receive signals from 433MHz devices (and other frequencies like 868 Mhz are possible too).

 

==868 and 915 MHz==
A lot of more recent hardware that uses Radio Frequencies to communicate do not use the 433 Mhz anymore but the also open 868 Mhz band (including more standardized protocols like Z-Wave, Zigbee, LoRa, etc.).
Not all hardware uses standardized protocols, a lot still uses their own manufacturer proprietary implementation. Like within the 433 Mhz spectrum, you need a transceiver hooked up to Domoticz to send and receive signal to- and from these devices. For example the RTL SDR dongles using the rtl_433 library (which also supports 868 Mhz and other frequencies).

 

==WiFi 2.4 GHz==
This is the same spectrum that the Wifi standard uses, but there are lots of less well known protocols that operate here too. It's also a bit of a wild west.

*[[MySensors|Mysensors.org: connecting with all MySensors-gateways]]
*[https://github.com/mario-peters/ShellyCloudPlugin Shelly Cloud Plugin] that works with many Shelly devices 

==Bluetooth==
A popular short-range wireless standard. The Raspberry Pi, the most popular platform for Domoticz, now has built in Bluetooth.

*[[BTAudio|Bluetooth Audio]] 

==Homekit (Apple)==
This is a protocol created by Apple.

*[[Homekit_Siri | Apple HomeKit with Siri support]] 

==1-wire==
This is a standard for connecting very simple sensors.

*[http://domoticz.com/wiki/1Wire Using 1-Wire with Domoticz] 

==DomBus==
RS485 serial bus protocol operating at 115200bps: with a 4 wires shielded cable it's possible to carry data and 12/24V power supply to all modules.

This protocol is used by [[Creasol_Dombus|Creasol DomBus]] modules.

==X10==
It's an older standard, but it checks out.

*[[X10 with CM11a|X10 devices with a CM11a]]
*[[X10 devices, CM15 Pro|X10 devices with a CM15 Pro]] 

==eHouse TCP/IP & UDP==
eHouse IP Controllers uses:

*- TCP/IP for direct communication (send commands/events) implementing challenge-response algoritm for security.
*- TCP/IP (via Internet / LAN / WiFi) via eHouse PRO server gathering all IP and NON IP controllers statuses.
*- UDP broadcasts for distributing IP controllers status all over LAN/WiFi network without connection to device 

eHouse NON IP Controllers:

*- work under eHouse PRO server supervision, which is a gateway/proxy and all statuses are also broadcasted by UDP.
*- TCP/IP commands directed to eHouse PRO server are resend to NON IP devices.
*[[eHouse]] | [[eHouse Protocol]] | [[eHouse Configuration]] | [[Supported Controllers]]

==Infrared==
IR (I.R. = infrared or infra-red)

*[[eHouse IR]]

==Unsorted==
Please help sort these.

*[[EnOcean]]
*[[S0Meter|S0-pulsecounter]]
*[[Basic Tellstick functionality with Domoticz]]
*[[Limitless/AppLamp_LED|Limitless/AppLamp/Milight RGBW bulbs/led strips]]
*[[Harmony Hub Control]]. Native [[Harmony Hub]](version 1.1956)
*[[Pi-Mote|Using Energenie Pi-mote with Domoticz]]
*[[LIFX|LIFX lightbulbs]]
*[[Wemo|Belkin WeMo]]
*[[MPD_%26_Domoticz|Music Player Daemon (MPD) & Domoticz]]
*[[SMASpot Monitoring in Domoticz]]
*[[Talking Domoticz|Let Domoticz speak to inform you]]

A larger list of devices that Domoticz supports can be found on the [[Hardware|hardware overview page]].

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]
[[Category:Hardware]]
[[Category:Scripting]]

=Continue to the next page of the introduction=

*[[Hardware| Hardware]]

 
[[Category:Plugins]]

Configuration

2026-06-10T08:13:35Z

Walter vl: /* AI Agent */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
 
 
Domoticz connects a lot of devices, so it's not surprising that there are a lot of settings you can dive into.

- Some devices can be directly connected to Domoticz through the network (Wifi or LAN). An example would be a smart thermostat like the [[Toon|Eneco Toon thermostat]]. 
- Others connect via Gateways, USB or LAN These are devices that enable access to a whole family of new things. An example would be a 433Mhz radiotransmitter like RFXCOM or any other device that acts as a bridge like [[Zigbee]] or [[Zwave]] 
- Domoticz can also interact with internet services, such as [[MQTT]], [[FibaroLink]], Google Pub/Sub and publish to IOT sites, [[Influxdb|InfluxDB]] etc. 

There is a [[Android|great Android app]] as well. And you can even connect your[[Kodi | media player]].

==Hardware/Devices==
[[File:Menu Setup Devices.png|frame]]
More general details about types of devices you can connect can be found in the following pages:

*[[Hardware Setup]] (menu Setup - Hardware) to add hardware
**[[Plugins|Python Plugins]] for additional Hardware/devices support
*[[Setup Devices|Device List]] (menu Setup - Devices)
**[[Managing Devices|Managing Devices (device navigation and edit)]]
**[[Dummy for virtual Switches|Dummy for Virtual Switches]]
*[[Camera Setup]]
*[[hardware|List of supported devices]]
*[[Setting up Device sharing|Setting up device sharing]] between Domoticz environments (eg holiday home)

==User Interface==
[[File:Dynamic Dashboard.png|right]]
After that you can change some settings that are user interface related:

*[[Application Settings]] (Menu '''Setup - Settings''') for central settings of themes, location, dashboard, backup, notifications etc.
*[[Floorplans]] Make an interactive floorplan of your building.
*[[Managing Devices#Dashboard|Dashboard]] Collect the most important devices on the first screen based on favourites
*[[DynamicDashboard|Dynamic Dashboard]] build your own live home overview with energy, weather, and per-phase power widgets
*[[Custom menu|Custom Menu]] for adding an extra user menu to link to other sites or pages
*[[Energy dashboard|Energy Dashboard]] to view your energy flows in your house

 
==Setup, More Options==
In Menu '''Setup --> More Options''' you can set the following options:
[[File:SetupCamera.png|right]]

*[[Camera Setup|Cameras]] to add and maintain cameras.
*[[Events]] to add and maintain automation events with DzVents, Lua , Python event scripts.
*[[Mobile devices]] to contol the mobile devices connected to Domoticz
*Push data to push Domoticz data to other environments
**[[HttpLink|Http]](s)
**[[Influxdb|InfluxDB]]
**Google PubSub
**[[FibaroLink]]
**[[MQTT Push]] (there is also a [[MQTT|MQTT Gateway]] for full MQTT messages integration)
*[[User variables|User Variables]] used in Event scripts or Hardware gateways
*Plans
**[[Floorplans|Roomplans / Floorplans]]
**[[Timer Plan|Timer plans]]
*[[User Management|Edit Users]] (also for [[Setting up Device sharing|Device sharing]])
*[[Custom icons for webinterface|Custom Icons]]
*[[Software update|Check for Update]]
*[[Security#Security Panel|Security panel]] to use Domoticz as an [[Alarm Setup|alarm system]].
*Restart/Shutdown system (= the complete computer, not only Domoticz!)

== AI Agent ==
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process at the <code>/mcp</code> endpoint. AI agents can now discover and control devices using the <code>search_devices</code> tool - making Domoticz one of the first home automation platforms with built-in MCP support.

An AI agent can create sensors and devices (<code>create_sensor</code> / <code>create_device</code>), hide or permanently delete them, and read full sensor history through <code>get_sensor_history</code> - daily calendar data for every sensor type plus the event log for switches and scenes. Battery and RSSI/signal levels now appear right in device search, with <code>hw_idx</code> and <code>include_unused</code> filters and resource-URI autocompletion to keep queries precise.

See for more instructions page [[MCP model context protocol LLM]]

==Remote Access==
To enable remote access from outside your local network there are various options. Please note that remote access will need extra attention for security (see next topic)

*Port forwarding (not secure), consult your network router manual to forwarding/NAT a port to your system.
*[[Installing a PPTP-VPN server on a Raspberry Pi|VPN]]
*[[WebServer Proxy|Webserver (Reverse) Proxy]]
*Secure tunnels like [https://ngrok.com/product ngrok] or [https://www.realvnc.com/en/ RealVNC]
*By [[Remote Control of Domoticz by Telegram Bot|Telegram Bot]]
*[[Alexa Smart Home Integration|Alexa Smart Home integration]]

==Security==
Once Domoticz is installed and it is accessible from outside your local network it's a good idea to secure it.

You can secure your Domoticz installation in numerous ways, from setting a [[Application Settings|password]] to enabling encrypted communication.

As a start read the wiki page [[Security]]

Examples for further security measures are:

*Setup [[User Management|User management]]
*[[Secure Remote Access]]
*[[Automated banning of IP that fails to login multiple times]] - Using 'fail2ban' to make your system more secure.
*[[Native HTTPS / SSL support]]
*[[Native secure access with Lets Encrypt]] 

==Troubleshooting==
'''Log File'''

When you experience strange behaviour of Domoticz please check the log file of Domoticz. It can be viewed trough the Domoticz user interface with menu '''Setup - Log'''.

You can filter on Status and Errors and also on text strings (ie to only view log entries of a specific device). Use "!" to filter out specific terms, eg !ZwaveJS to filter out all log lines with value "ZwaveJS"

The red cross top right after filter field is to clear the web log file.

The log file in the Domoticz window shows max 300 lines. You can enable a local log file on the file system with [[Command line parameters]] to see all logging but be aware that this can become a large file.

On your linux system you can find the log file in <code>/var/log</code> or as specified in the file <code>/etc/init.d/domoticz.sh</code> See for instructions wiki page [[Troubleshooting#Activate%20logging%20to%20OS-file%20.28with%20or%20without%20debugging.29|Troubleshooting#Activate logging to OS-file with or without debugging]]

The log level of hardware can be set on the hardware page: [[Hardware Setup#Update Hardware Gateway]]

For more troubleshooting tips see the wiki page [[Troubleshooting]]

[[File:SetupLog.png]]

'''Lost password''' If you have forgotten your password of the website protection follow the procedure [[Lost Username Password|Lost username/password]] 

For more Domoticz troubleshooting hints see page [[Troubleshooting|Troubleshooting.]]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]

==Continue to the next page of the introduction==
[[Customization| Customization]]

Configuration

2026-06-10T08:10:20Z

Walter vl: /* AI Agent */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
 
 
Domoticz connects a lot of devices, so it's not surprising that there are a lot of settings you can dive into.

- Some devices can be directly connected to Domoticz through the network (Wifi or LAN). An example would be a smart thermostat like the [[Toon|Eneco Toon thermostat]]. 
- Others connect via Gateways, USB or LAN These are devices that enable access to a whole family of new things. An example would be a 433Mhz radiotransmitter like RFXCOM or any other device that acts as a bridge like [[Zigbee]] or [[Zwave]] 
- Domoticz can also interact with internet services, such as [[MQTT]], [[FibaroLink]], Google Pub/Sub and publish to IOT sites, [[Influxdb|InfluxDB]] etc. 

There is a [[Android|great Android app]] as well. And you can even connect your[[Kodi | media player]].

==Hardware/Devices==
[[File:Menu Setup Devices.png|frame]]
More general details about types of devices you can connect can be found in the following pages:

*[[Hardware Setup]] (menu Setup - Hardware) to add hardware
**[[Plugins|Python Plugins]] for additional Hardware/devices support
*[[Setup Devices|Device List]] (menu Setup - Devices)
**[[Managing Devices|Managing Devices (device navigation and edit)]]
**[[Dummy for virtual Switches|Dummy for Virtual Switches]]
*[[Camera Setup]]
*[[hardware|List of supported devices]]
*[[Setting up Device sharing|Setting up device sharing]] between Domoticz environments (eg holiday home)

==User Interface==
[[File:Dynamic Dashboard.png|right]]
After that you can change some settings that are user interface related:

*[[Application Settings]] (Menu '''Setup - Settings''') for central settings of themes, location, dashboard, backup, notifications etc.
*[[Floorplans]] Make an interactive floorplan of your building.
*[[Managing Devices#Dashboard|Dashboard]] Collect the most important devices on the first screen based on favourites
*[[DynamicDashboard|Dynamic Dashboard]] build your own live home overview with energy, weather, and per-phase power widgets
*[[Custom menu|Custom Menu]] for adding an extra user menu to link to other sites or pages
*[[Energy dashboard|Energy Dashboard]] to view your energy flows in your house

 
==Setup, More Options==
In Menu '''Setup --> More Options''' you can set the following options:
[[File:SetupCamera.png|right]]

*[[Camera Setup|Cameras]] to add and maintain cameras.
*[[Events]] to add and maintain automation events with DzVents, Lua , Python event scripts.
*[[Mobile devices]] to contol the mobile devices connected to Domoticz
*Push data to push Domoticz data to other environments
**[[HttpLink|Http]](s)
**[[Influxdb|InfluxDB]]
**Google PubSub
**[[FibaroLink]]
**[[MQTT Push]] (there is also a [[MQTT|MQTT Gateway]] for full MQTT messages integration)
*[[User variables|User Variables]] used in Event scripts or Hardware gateways
*Plans
**[[Floorplans|Roomplans / Floorplans]]
**[[Timer Plan|Timer plans]]
*[[User Management|Edit Users]] (also for [[Setting up Device sharing|Device sharing]])
*[[Custom icons for webinterface|Custom Icons]]
*[[Software update|Check for Update]]
*[[Security#Security Panel|Security panel]] to use Domoticz as an [[Alarm Setup|alarm system]].
*Restart/Shutdown system (= the complete computer, not only Domoticz!)

== AI Agent ==
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process at the <code>/mcp</code> endpoint. AI agents can now discover and control devices using the <code>search_devices</code> tool - making Domoticz one of the first home automation platforms with built-in MCP support.

See for more instructions page [[MCP model context protocol LLM]]

==Remote Access==
To enable remote access from outside your local network there are various options. Please note that remote access will need extra attention for security (see next topic)

*Port forwarding (not secure), consult your network router manual to forwarding/NAT a port to your system.
*[[Installing a PPTP-VPN server on a Raspberry Pi|VPN]]
*[[WebServer Proxy|Webserver (Reverse) Proxy]]
*Secure tunnels like [https://ngrok.com/product ngrok] or [https://www.realvnc.com/en/ RealVNC]
*By [[Remote Control of Domoticz by Telegram Bot|Telegram Bot]]
*[[Alexa Smart Home Integration|Alexa Smart Home integration]]

==Security==
Once Domoticz is installed and it is accessible from outside your local network it's a good idea to secure it.

You can secure your Domoticz installation in numerous ways, from setting a [[Application Settings|password]] to enabling encrypted communication.

As a start read the wiki page [[Security]]

Examples for further security measures are:

*Setup [[User Management|User management]]
*[[Secure Remote Access]]
*[[Automated banning of IP that fails to login multiple times]] - Using 'fail2ban' to make your system more secure.
*[[Native HTTPS / SSL support]]
*[[Native secure access with Lets Encrypt]] 

==Troubleshooting==
'''Log File'''

When you experience strange behaviour of Domoticz please check the log file of Domoticz. It can be viewed trough the Domoticz user interface with menu '''Setup - Log'''.

You can filter on Status and Errors and also on text strings (ie to only view log entries of a specific device). Use "!" to filter out specific terms, eg !ZwaveJS to filter out all log lines with value "ZwaveJS"

The red cross top right after filter field is to clear the web log file.

The log file in the Domoticz window shows max 300 lines. You can enable a local log file on the file system with [[Command line parameters]] to see all logging but be aware that this can become a large file.

On your linux system you can find the log file in <code>/var/log</code> or as specified in the file <code>/etc/init.d/domoticz.sh</code> See for instructions wiki page [[Troubleshooting#Activate%20logging%20to%20OS-file%20.28with%20or%20without%20debugging.29|Troubleshooting#Activate logging to OS-file with or without debugging]]

The log level of hardware can be set on the hardware page: [[Hardware Setup#Update Hardware Gateway]]

For more troubleshooting tips see the wiki page [[Troubleshooting]]

[[File:SetupLog.png]]

'''Lost password''' If you have forgotten your password of the website protection follow the procedure [[Lost Username Password|Lost username/password]] 

For more Domoticz troubleshooting hints see page [[Troubleshooting|Troubleshooting.]]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]

==Continue to the next page of the introduction==
[[Customization| Customization]]

Configuration

2026-06-09T21:01:12Z

Walter vl: /* User Interface */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
 
 
Domoticz connects a lot of devices, so it's not surprising that there are a lot of settings you can dive into.

- Some devices can be directly connected to Domoticz through the network (Wifi or LAN). An example would be a smart thermostat like the [[Toon|Eneco Toon thermostat]]. 
- Others connect via Gateways, USB or LAN These are devices that enable access to a whole family of new things. An example would be a 433Mhz radiotransmitter like RFXCOM or any other device that acts as a bridge like [[Zigbee]] or [[Zwave]] 
- Domoticz can also interact with internet services, such as [[MQTT]], [[FibaroLink]], Google Pub/Sub and publish to IOT sites, [[Influxdb|InfluxDB]] etc. 

There is a [[Android|great Android app]] as well. And you can even connect your[[Kodi | media player]].

==Hardware/Devices==
[[File:Menu Setup Devices.png|frame]]
More general details about types of devices you can connect can be found in the following pages:

*[[Hardware Setup]] (menu Setup - Hardware) to add hardware
**[[Plugins|Python Plugins]] for additional Hardware/devices support
*[[Setup Devices|Device List]] (menu Setup - Devices)
**[[Managing Devices|Managing Devices (device navigation and edit)]]
**[[Dummy for virtual Switches|Dummy for Virtual Switches]]
*[[Camera Setup]]
*[[hardware|List of supported devices]]
*[[Setting up Device sharing|Setting up device sharing]] between Domoticz environments (eg holiday home)

==User Interface==
[[File:Dynamic Dashboard.png|right]]
After that you can change some settings that are user interface related:

*[[Application Settings]] (Menu '''Setup - Settings''') for central settings of themes, location, dashboard, backup, notifications etc.
*[[Floorplans]] Make an interactive floorplan of your building.
*[[Managing Devices#Dashboard|Dashboard]] Collect the most important devices on the first screen based on favourites
*[[DynamicDashboard|Dynamic Dashboard]] build your own live home overview with energy, weather, and per-phase power widgets
*[[Custom menu|Custom Menu]] for adding an extra user menu to link to other sites or pages
*[[Energy dashboard|Energy Dashboard]] to view your energy flows in your house

 
==Setup, More Options==
In Menu '''Setup --> More Options''' you can set the following options:
[[File:SetupCamera.png|right]]

*[[Camera Setup|Cameras]] to add and maintain cameras.
*[[Events]] to add and maintain automation events with DzVents, Lua , Python event scripts.
*[[Mobile devices]] to contol the mobile devices connected to Domoticz
*Push data to push Domoticz data to other environments
**[[HttpLink|Http]](s)
**[[Influxdb|InfluxDB]]
**Google PubSub
**[[FibaroLink]]
**[[MQTT Push]] (there is also a [[MQTT|MQTT Gateway]] for full MQTT messages integration)
*[[User variables|User Variables]] used in Event scripts or Hardware gateways
*Plans
**[[Floorplans|Roomplans / Floorplans]]
**[[Timer Plan|Timer plans]]
*[[User Management|Edit Users]] (also for [[Setting up Device sharing|Device sharing]])
*[[Custom icons for webinterface|Custom Icons]]
*[[Software update|Check for Update]]
*[[Security#Security Panel|Security panel]] to use Domoticz as an [[Alarm Setup|alarm system]].
*Restart/Shutdown system (= the complete computer, not only Domoticz!)

== AI Agent ==
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process.

See for more instructions page [[MCP model context protocol LLM]]

==Remote Access==
To enable remote access from outside your local network there are various options. Please note that remote access will need extra attention for security (see next topic)

*Port forwarding (not secure), consult your network router manual to forwarding/NAT a port to your system.
*[[Installing a PPTP-VPN server on a Raspberry Pi|VPN]]
*[[WebServer Proxy|Webserver (Reverse) Proxy]]
*Secure tunnels like [https://ngrok.com/product ngrok] or [https://www.realvnc.com/en/ RealVNC]
*By [[Remote Control of Domoticz by Telegram Bot|Telegram Bot]]
*[[Alexa Smart Home Integration|Alexa Smart Home integration]]

==Security==
Once Domoticz is installed and it is accessible from outside your local network it's a good idea to secure it.

You can secure your Domoticz installation in numerous ways, from setting a [[Application Settings|password]] to enabling encrypted communication.

As a start read the wiki page [[Security]]

Examples for further security measures are:

*Setup [[User Management|User management]]
*[[Secure Remote Access]]
*[[Automated banning of IP that fails to login multiple times]] - Using 'fail2ban' to make your system more secure.
*[[Native HTTPS / SSL support]]
*[[Native secure access with Lets Encrypt]] 

==Troubleshooting==
'''Log File'''

When you experience strange behaviour of Domoticz please check the log file of Domoticz. It can be viewed trough the Domoticz user interface with menu '''Setup - Log'''.

You can filter on Status and Errors and also on text strings (ie to only view log entries of a specific device). Use "!" to filter out specific terms, eg !ZwaveJS to filter out all log lines with value "ZwaveJS"

The red cross top right after filter field is to clear the web log file.

The log file in the Domoticz window shows max 300 lines. You can enable a local log file on the file system with [[Command line parameters]] to see all logging but be aware that this can become a large file.

On your linux system you can find the log file in <code>/var/log</code> or as specified in the file <code>/etc/init.d/domoticz.sh</code> See for instructions wiki page [[Troubleshooting#Activate%20logging%20to%20OS-file%20.28with%20or%20without%20debugging.29|Troubleshooting#Activate logging to OS-file with or without debugging]]

The log level of hardware can be set on the hardware page: [[Hardware Setup#Update Hardware Gateway]]

For more troubleshooting tips see the wiki page [[Troubleshooting]]

[[File:SetupLog.png]]

'''Lost password''' If you have forgotten your password of the website protection follow the procedure [[Lost Username Password|Lost username/password]] 

For more Domoticz troubleshooting hints see page [[Troubleshooting|Troubleshooting.]]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]

==Continue to the next page of the introduction==
[[Customization| Customization]]

Configuration

2026-06-09T20:58:38Z

Walter vl: /* User Interface */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
 
 
Domoticz connects a lot of devices, so it's not surprising that there are a lot of settings you can dive into.

- Some devices can be directly connected to Domoticz through the network (Wifi or LAN). An example would be a smart thermostat like the [[Toon|Eneco Toon thermostat]]. 
- Others connect via Gateways, USB or LAN These are devices that enable access to a whole family of new things. An example would be a 433Mhz radiotransmitter like RFXCOM or any other device that acts as a bridge like [[Zigbee]] or [[Zwave]] 
- Domoticz can also interact with internet services, such as [[MQTT]], [[FibaroLink]], Google Pub/Sub and publish to IOT sites, [[Influxdb|InfluxDB]] etc. 

There is a [[Android|great Android app]] as well. And you can even connect your[[Kodi | media player]].

==Hardware/Devices==
[[File:Menu Setup Devices.png|frame]]
More general details about types of devices you can connect can be found in the following pages:

*[[Hardware Setup]] (menu Setup - Hardware) to add hardware
**[[Plugins|Python Plugins]] for additional Hardware/devices support
*[[Setup Devices|Device List]] (menu Setup - Devices)
**[[Managing Devices|Managing Devices (device navigation and edit)]]
**[[Dummy for virtual Switches|Dummy for Virtual Switches]]
*[[Camera Setup]]
*[[hardware|List of supported devices]]
*[[Setting up Device sharing|Setting up device sharing]] between Domoticz environments (eg holiday home)

==User Interface==
[[File:Dynamic Dashboard.png|right]]
After that you can change some settings that are user interface related:

*[[Application Settings]] (Menu '''Setup - Settings''') for central settings of themes, location, dashboard, backup, notifications etc.
*[[Floorplans]] Make an interactive floorplan of your building.
*[[Managing Devices#Dashboard|Dashboard]] Collect the most important devices on the first screen based on favourites
*[[DynamicDashboard|Dynamic Dashboard]] build your own live home overview with energy, weather, and per-phase power widgets
*[[Custom menu|Custom Menu]] for adding an extra user menu to link to other sites or pages

 
==Setup, More Options==
In Menu '''Setup --> More Options''' you can set the following options:
[[File:SetupCamera.png|right]]

*[[Camera Setup|Cameras]] to add and maintain cameras.
*[[Events]] to add and maintain automation events with DzVents, Lua , Python event scripts.
*[[Mobile devices]] to contol the mobile devices connected to Domoticz
*Push data to push Domoticz data to other environments
**[[HttpLink|Http]](s)
**[[Influxdb|InfluxDB]]
**Google PubSub
**[[FibaroLink]]
**[[MQTT Push]] (there is also a [[MQTT|MQTT Gateway]] for full MQTT messages integration)
*[[User variables|User Variables]] used in Event scripts or Hardware gateways
*Plans
**[[Floorplans|Roomplans / Floorplans]]
**[[Timer Plan|Timer plans]]
*[[User Management|Edit Users]] (also for [[Setting up Device sharing|Device sharing]])
*[[Custom icons for webinterface|Custom Icons]]
*[[Software update|Check for Update]]
*[[Security#Security Panel|Security panel]] to use Domoticz as an [[Alarm Setup|alarm system]].
*Restart/Shutdown system (= the complete computer, not only Domoticz!)

== AI Agent ==
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process.

See for more instructions page [[MCP model context protocol LLM]]

==Remote Access==
To enable remote access from outside your local network there are various options. Please note that remote access will need extra attention for security (see next topic)

*Port forwarding (not secure), consult your network router manual to forwarding/NAT a port to your system.
*[[Installing a PPTP-VPN server on a Raspberry Pi|VPN]]
*[[WebServer Proxy|Webserver (Reverse) Proxy]]
*Secure tunnels like [https://ngrok.com/product ngrok] or [https://www.realvnc.com/en/ RealVNC]
*By [[Remote Control of Domoticz by Telegram Bot|Telegram Bot]]
*[[Alexa Smart Home Integration|Alexa Smart Home integration]]

==Security==
Once Domoticz is installed and it is accessible from outside your local network it's a good idea to secure it.

You can secure your Domoticz installation in numerous ways, from setting a [[Application Settings|password]] to enabling encrypted communication.

As a start read the wiki page [[Security]]

Examples for further security measures are:

*Setup [[User Management|User management]]
*[[Secure Remote Access]]
*[[Automated banning of IP that fails to login multiple times]] - Using 'fail2ban' to make your system more secure.
*[[Native HTTPS / SSL support]]
*[[Native secure access with Lets Encrypt]] 

==Troubleshooting==
'''Log File'''

When you experience strange behaviour of Domoticz please check the log file of Domoticz. It can be viewed trough the Domoticz user interface with menu '''Setup - Log'''.

You can filter on Status and Errors and also on text strings (ie to only view log entries of a specific device). Use "!" to filter out specific terms, eg !ZwaveJS to filter out all log lines with value "ZwaveJS"

The red cross top right after filter field is to clear the web log file.

The log file in the Domoticz window shows max 300 lines. You can enable a local log file on the file system with [[Command line parameters]] to see all logging but be aware that this can become a large file.

On your linux system you can find the log file in <code>/var/log</code> or as specified in the file <code>/etc/init.d/domoticz.sh</code> See for instructions wiki page [[Troubleshooting#Activate%20logging%20to%20OS-file%20.28with%20or%20without%20debugging.29|Troubleshooting#Activate logging to OS-file with or without debugging]]

The log level of hardware can be set on the hardware page: [[Hardware Setup#Update Hardware Gateway]]

For more troubleshooting tips see the wiki page [[Troubleshooting]]

[[File:SetupLog.png]]

'''Lost password''' If you have forgotten your password of the website protection follow the procedure [[Lost Username Password|Lost username/password]] 

For more Domoticz troubleshooting hints see page [[Troubleshooting|Troubleshooting.]]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]

==Continue to the next page of the introduction==
[[Customization| Customization]]

File:Dynamic Dashboard.png

2026-06-09T20:57:33Z

Walter vl:

Dynamic Dashboard

Configuration

2026-06-09T20:48:26Z

Walter vl: /* Remote Access */

'''''New to Domoticz? Have a look at the [[Getting started]] page to connect your first devices, services or gateways.'''''
 
 
Domoticz connects a lot of devices, so it's not surprising that there are a lot of settings you can dive into.

- Some devices can be directly connected to Domoticz through the network (Wifi or LAN). An example would be a smart thermostat like the [[Toon|Eneco Toon thermostat]]. 
- Others connect via Gateways, USB or LAN These are devices that enable access to a whole family of new things. An example would be a 433Mhz radiotransmitter like RFXCOM or any other device that acts as a bridge like [[Zigbee]] or [[Zwave]] 
- Domoticz can also interact with internet services, such as [[MQTT]], [[FibaroLink]], Google Pub/Sub and publish to IOT sites, [[Influxdb|InfluxDB]] etc. 

There is a [[Android|great Android app]] as well. And you can even connect your[[Kodi | media player]].

==Hardware/Devices==
[[File:Menu Setup Devices.png|frame]]
More general details about types of devices you can connect can be found in the following pages:

*[[Hardware Setup]] (menu Setup - Hardware) to add hardware
**[[Plugins|Python Plugins]] for additional Hardware/devices support
*[[Setup Devices|Device List]] (menu Setup - Devices)
**[[Managing Devices|Managing Devices (device navigation and edit)]]
**[[Dummy for virtual Switches|Dummy for Virtual Switches]]
*[[Camera Setup]]
*[[hardware|List of supported devices]]
*[[Setting up Device sharing|Setting up device sharing]] between Domoticz environments (eg holiday home)

==User Interface==
After that you can change some settings that are user interface related:

*[[Application Settings]] (Menu '''Setup - Settings''') for central settings of themes, location, dashboard, backup, notifications etc.
*[[Floorplans]] Make an interactive floorplan of your building.
*[[Managing Devices#Dashboard|Dashboard]] Collect the most important devices on the first screen based on favourites
*[[DynamicDashboard|Dynamic Dashboard]] build your own live home overview with energy, weather, and per-phase power widgets
*[[Custom menu|Custom Menu]] for adding an extra user menu to link to other sites or pages

 
==Setup, More Options==
In Menu '''Setup --> More Options''' you can set the following options:
[[File:SetupCamera.png|right]]

*[[Camera Setup|Cameras]] to add and maintain cameras.
*[[Events]] to add and maintain automation events with DzVents, Lua , Python event scripts.
*[[Mobile devices]] to contol the mobile devices connected to Domoticz
*Push data to push Domoticz data to other environments
**[[HttpLink|Http]](s)
**[[Influxdb|InfluxDB]]
**Google PubSub
**[[FibaroLink]]
**[[MQTT Push]] (there is also a [[MQTT|MQTT Gateway]] for full MQTT messages integration)
*[[User variables|User Variables]] used in Event scripts or Hardware gateways
*Plans
**[[Floorplans|Roomplans / Floorplans]]
**[[Timer Plan|Timer plans]]
*[[User Management|Edit Users]] (also for [[Setting up Device sharing|Device sharing]])
*[[Custom icons for webinterface|Custom Icons]]
*[[Software update|Check for Update]]
*[[Security#Security Panel|Security panel]] to use Domoticz as an [[Alarm Setup|alarm system]].
*Restart/Shutdown system (= the complete computer, not only Domoticz!)

== AI Agent ==
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process.

See for more instructions page [[MCP model context protocol LLM]]

==Remote Access==
To enable remote access from outside your local network there are various options. Please note that remote access will need extra attention for security (see next topic)

*Port forwarding (not secure), consult your network router manual to forwarding/NAT a port to your system.
*[[Installing a PPTP-VPN server on a Raspberry Pi|VPN]]
*[[WebServer Proxy|Webserver (Reverse) Proxy]]
*Secure tunnels like [https://ngrok.com/product ngrok] or [https://www.realvnc.com/en/ RealVNC]
*By [[Remote Control of Domoticz by Telegram Bot|Telegram Bot]]
*[[Alexa Smart Home Integration|Alexa Smart Home integration]]

==Security==
Once Domoticz is installed and it is accessible from outside your local network it's a good idea to secure it.

You can secure your Domoticz installation in numerous ways, from setting a [[Application Settings|password]] to enabling encrypted communication.

As a start read the wiki page [[Security]]

Examples for further security measures are:

*Setup [[User Management|User management]]
*[[Secure Remote Access]]
*[[Automated banning of IP that fails to login multiple times]] - Using 'fail2ban' to make your system more secure.
*[[Native HTTPS / SSL support]]
*[[Native secure access with Lets Encrypt]] 

==Troubleshooting==
'''Log File'''

When you experience strange behaviour of Domoticz please check the log file of Domoticz. It can be viewed trough the Domoticz user interface with menu '''Setup - Log'''.

You can filter on Status and Errors and also on text strings (ie to only view log entries of a specific device). Use "!" to filter out specific terms, eg !ZwaveJS to filter out all log lines with value "ZwaveJS"

The red cross top right after filter field is to clear the web log file.

The log file in the Domoticz window shows max 300 lines. You can enable a local log file on the file system with [[Command line parameters]] to see all logging but be aware that this can become a large file.

On your linux system you can find the log file in <code>/var/log</code> or as specified in the file <code>/etc/init.d/domoticz.sh</code> See for instructions wiki page [[Troubleshooting#Activate%20logging%20to%20OS-file%20.28with%20or%20without%20debugging.29|Troubleshooting#Activate logging to OS-file with or without debugging]]

The log level of hardware can be set on the hardware page: [[Hardware Setup#Update Hardware Gateway]]

For more troubleshooting tips see the wiki page [[Troubleshooting]]

[[File:SetupLog.png]]

'''Lost password''' If you have forgotten your password of the website protection follow the procedure [[Lost Username Password|Lost username/password]] 

For more Domoticz troubleshooting hints see page [[Troubleshooting|Troubleshooting.]]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]

==Continue to the next page of the introduction==
[[Customization| Customization]]

Integrations and Protocols

2026-06-09T20:46:49Z

Walter vl: /* Plugins (Addons) */

Domoticz can speak a lot of device languages and connect to many different interfaces. Those devices are in the world of computers techically called "protocols" and computing interfaces are called API (Application Programming Interface).

This page is about helping you summerize languages or 'protocols' which Domoticz can understand, and other ways of helping Domoticz connecting to different devices or other bridges/hubs/gateways/controllers, for example through plugins (addons).

This summery also tries mention a few examples of such devices.

=Plugins (Addons)=
Python Plugins (sometimes also refered to as addons, add-ons, or extensions) expand Domoticz abilties to connect to even more devices, bridges, gateways, hubs, controllers, off-line or online services, and more.

*[[Plugins]] - A list of plugins available. New ones are rapidly being added. Look in the forum under 'python' to find the latest additions.
*[[Using_Python_plugins]] - Details on how to install a plugin.
*[[Developing a Python plugin]] - Details on how to develop your own plugin.

==On your device==
Your Domoticz server might have built-in sensors, or talk to other software on your server.

*[[Adding internal pc sensors to Domoticz on Windows systems|Adding internal PC sensors to Domoticz on Windows systems]]
*[[Write_Domoticz_logfile_to_Synology_Log_Center|Write Domoticz log to Synology Log Center]]
*[[PiFace]] 

==USB==
Plug devices directly into your Domoticz server.

*[[Voltcraft_CO-20 | Voltcraft CO-20 airquality sensor]] 

==Buienradar==
Your own private Buienradar Weatherstation. From Domoticz build V4.11230 and up it is possible to add native Buienradar instead of using plugin

*[[Buienradar | Buienradar native implementation]] 

= AI Agent =
Domoticz adds built-in support for the Model Context Protocol (MCP), allowing AI assistants and LLM clients to monitor and control your home automation system directly — without any external intermediary process.

See for more instructions page [[MCP model context protocol LLM]]

=Protocols=
Below you will find a number of protcols, and details about gateways that give access to large groups of devices using those protocols. Gateways are often devices that plug into or communicate with your server, such as a bluetooth dongle or wireless receiver and transmitter.

==IP (Internet Protocol) with TCP/UDP and HTTP==
IP (Internet Protocol) are your everyday network protocols used on local networks and the internet. This is the basic language spoken by all servers and computers on the internet and by devices in your home network, including your WiFi.

===Wired & Wireless===
These are devices that have gotten an IP address on your local network. Your router hands out these IP addresses.

*[[Philips Hue Lights]]
*[[Fritzbox|FRITZ!Box callmonitor]]
*[[Wake-up_On_Lan|Wake-on-LAN (WoL) a PC with Domoticz]]
*[[Sonos|Sonos: different solutions for integrating Sonos within Domoticz]]
*[[Essent|Essent E-Thermostat (ICY)]]
*[[ESP8266 WiFi module]] 

===Web===
These are services on the internet that you connect to through your internet router. Domoticz can talk to all kinds of services on the internet and get or deposit data there, such as the current weather.

*[[HttpLink|Push data from Domoticz to your own server]]
*[[Weather forecast from forecast.io in Domoticz|<s>Weather forecast from forecast.io in Domoticz</s>]] Not functional any more
*[[Virtual weather devices|<s>Virtual weather devices (Weather Underground)</s>]] Not functional anymore
*[[Open Weather Map]] devices
*[[Domoticz and PvOutput.org|Domoticz and PVOutput.org]]
*[[Telegram Bot|Installing Telegram Notification System - Telegram Bot Method]]
*[[Secure_Nginx_Proxy_Setup|x509-Auth w/Nginx for secure remote access.]]
*[[Smappee |Smappee energymonitor in Domoticz]]
*[https://www.npmjs.com/package/corrently4domoticz Corrently - German Green Power Index in Domoticz] (Node JS Package) 

==MQTT==
This standard, that works on top op TCP/IP, has been around for decades, but has been embraced as the Internet of Things (IoT) hype grew. Domoticz supports [[MQTT]], and will listen on the ''domoticz/in'' topic.

Domoticz also supports platforms that use the MQTT HA Auto Discover protocol, see wiki [[MQTT|MQTT Auto discover Gateway]]

 

==LoRa==
For devices that use LoRa radio technology, a [[TTNMQTT]] module is available which retrieves data using MQTT from The Things Network.
 

==Z-Wave==
The Z-Wave protocol propriatory wireless standard created especially for smart devices,

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Z-Wave on consist of several generations where the newer versions are back-wards compatible with the older generation however incoperating older generation devices into can sometimes lower the encryption level used in your network-mesh.

The downside of the Z-Wave protocol being propriatory is means that there are less manufacturers and devices cost more but the upside is that because it is propriatory interoperability between differet manufacturers is much better than more open protocols, so compatibility between devices and gateways/bridges/controllers is almost always better.

*Using [[Zwave-JS-UI]]
*[[Zwave|Setting up Z-Wave]] with OpenZwave (deprecated)

 

==Zigbee==
Zigbee is a suite of IEEE 802.15.4-based protocol standards some of which are designed to be used by smart devices for home automation.

It creating its own isolated wireless network-mesh which boosts in range the more mains-powered devices you that you add your network mesh, with all mains-powered devices acting as repeater. t supports encyption, so it is harder to listen in on your devices.

Zigbee protocol standards are managed by the Zigbee Alliance and they have relativly low royalty fees and allow anyone to manufacturer chips for Zigbee and Zigbee protocol stacks. Official certification of manufacturers devices by the Zigbee Alliance cost more and though it is not requires it is still recommended, which makes it possible for devices to be non cerfified devices to be cheap and certified devices to be relativly inexpensive.

The downside of the Zigbee protocol being loosley controlled by Zigbee Alliance, not even requireing certifications or quality control means that there can be interoperability issues between differet manufacturers, so compatibility between devices and gateways/bridges/controllers can not be garanteed. Because of this is recommended to preferably buy devices that are "Zigbee 3.0" cerfified by the Zigbee Alliance as that should mean that they have been independently tested to at least meet their minimum requirements of follwing the official Zigbee standards.

 

*[[Zigbee#Zigbee support in Domoticz|Options available for connecting to Zigbee devices from Domoticz]] 

== Matter ==
Matter is a new secure, reliable and local standard protocol for smart/IoT devices launched at the end of 2022 by the Connectivity Standards Alliance.

Domoticz has a Matter integration based on matter.js server, see wiki page [[Matter]]

==315 and 433 MHz==
The 433MHz frequency range in Europe and Asia as well as 315 MHz radio frequency range in North America are the wild west radio spectrums of the wireless world because anyone can use it freely without any licences or permissions needed as long as the do not have too stong radios.

Because there are basically no rules all kinds of "cowboy" devices have been built with an equally big amount of different languages (protocol) being spoken.

The frequency range for the "433MHz" spectrum is actually a range from 433.05 MHz to 434.79 MHz with center frequency being 433.92 MHz (which is also the most commonly uses by most of these types of devices in Europe and Asia). The frequency range for the "315MHz" spectrum is actually a range from 315.xx MHz to 315.xx MHz with center frequency being 315.xx MHz (which is also the most commonly uses by most of these types of devices in North America).

Most of the devices in these spectrums do not support tw-way communcation and in most cases the use unencrypted communications, so in theory anyone could listen in on it, or even control your devices. So please don't buy a pacemaker with a 433Mhz remote.

Thanks to gateways/bridges like RFXcom and RFLink which speak and can translate a lot of these languages (protocols), Domoticz can interact with a lof of those type of devices.

 

*[[RFXcom|Setting up RFXCom]]. This is a commercial product, with two versions. Please buy the newer E version.
*[[RFLink|Setting up RFLink]]. This is free (but not open source) software which you can flash on an Arduino Mega.
*[[rtl_433|Setting up rtl_433]]. This is free, open source software which uses a software defined radio USB dongle to receive signals from 433MHz devices (and other frequencies like 868 Mhz are possible too).

 

==868 and 915 MHz==
A lot of more recent hardware that uses Radio Frequencies to communicate do not use the 433 Mhz anymore but the also open 868 Mhz band (including more standardized protocols like Z-Wave, Zigbee, LoRa, etc.).
Not all hardware uses standardized protocols, a lot still uses their own manufacturer proprietary implementation. Like within the 433 Mhz spectrum, you need a transceiver hooked up to Domoticz to send and receive signal to- and from these devices. For example the RTL SDR dongles using the rtl_433 library (which also supports 868 Mhz and other frequencies).

 

==WiFi 2.4 GHz==
This is the same spectrum that the Wifi standard uses, but there are lots of less well known protocols that operate here too. It's also a bit of a wild west.

*[[MySensors|Mysensors.org: connecting with all MySensors-gateways]]
*[https://github.com/mario-peters/ShellyCloudPlugin Shelly Cloud Plugin] that works with many Shelly devices 

==Bluetooth==
A popular short-range wireless standard. The Raspberry Pi, the most popular platform for Domoticz, now has built in Bluetooth.

*[[BTAudio|Bluetooth Audio]] 

==Homekit (Apple)==
This is a protocol created by Apple.

*[[Homekit_Siri | Apple HomeKit with Siri support]] 

==1-wire==
This is a standard for connecting very simple sensors.

*[http://domoticz.com/wiki/1Wire Using 1-Wire with Domoticz] 

==DomBus==
RS485 serial bus protocol operating at 115200bps: with a 4 wires shielded cable it's possible to carry data and 12/24V power supply to all modules.

This protocol is used by [[Creasol_Dombus|Creasol DomBus]] modules.

==X10==
It's an older standard, but it checks out.

*[[X10 with CM11a|X10 devices with a CM11a]]
*[[X10 devices, CM15 Pro|X10 devices with a CM15 Pro]] 

==eHouse TCP/IP & UDP==
eHouse IP Controllers uses:

*- TCP/IP for direct communication (send commands/events) implementing challenge-response algoritm for security.
*- TCP/IP (via Internet / LAN / WiFi) via eHouse PRO server gathering all IP and NON IP controllers statuses.
*- UDP broadcasts for distributing IP controllers status all over LAN/WiFi network without connection to device 

eHouse NON IP Controllers:

*- work under eHouse PRO server supervision, which is a gateway/proxy and all statuses are also broadcasted by UDP.
*- TCP/IP commands directed to eHouse PRO server are resend to NON IP devices.
*[[eHouse]] | [[eHouse Protocol]] | [[eHouse Configuration]] | [[Supported Controllers]]

==Infrared==
IR (I.R. = infrared or infra-red)

*[[eHouse IR]]

==Unsorted==
Please help sort these.

*[[EnOcean]]
*[[S0Meter|S0-pulsecounter]]
*[[Basic Tellstick functionality with Domoticz]]
*[[Limitless/AppLamp_LED|Limitless/AppLamp/Milight RGBW bulbs/led strips]]
*[[Harmony Hub Control]]. Native [[Harmony Hub]](version 1.1956)
*[[Pi-Mote|Using Energenie Pi-mote with Domoticz]]
*[[LIFX|LIFX lightbulbs]]
*[[Wemo|Belkin WeMo]]
*[[MPD_%26_Domoticz|Music Player Daemon (MPD) & Domoticz]]
*[[SMASpot Monitoring in Domoticz]]
*[[Talking Domoticz|Let Domoticz speak to inform you]]

A larger list of devices that Domoticz supports can be found on the [[Hardware|hardware overview page]].

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Setup]]
[[Category:Hardware]]
[[Category:Scripting]]

=Continue to the next page of the introduction=

*[[Hardware| Hardware]]

 
[[Category:Plugins]]