Hub

Articles

• Devices
  • API
    • Device Commands
    • hub.devices.list
    • hub.device.name.set
    • hub.device.room.set
    • hub.device.armed.set
    • hub.device.status.check
    • hub.device.force_remove
    • hub.device.check
    • hub.devices.service.notifications.set
    • hub.devices.firmware.update
  • Categories
  • Device Types
  • Integrated Devices
    • List of integrated devices
    • 2Gig
    • Advanced Control Technologies
    • Aeon
    • Aeotec
    • Aeotec
    • Aizyc
    • August
    • Building 36
    • Climax
    • Danfoss
    • Delaney Hardware
    • Digital Home System
    • Dome
    • Dome
    • Domitech
    • Duwi
    • Dynaquip Controls
    • Eaton
    • Econet Controls
    • Ecolink
    • Ecolink/Schlage
    • Ei Electronics
    • Electronic Solutions
    • Enerwave Green Automation
    • Everspring
    • Everspring/Chromagic
    • Everspring/Hawking/Chromagic
    • Evolve
    • Express Controls
    • Ezlo
    • Fibaro
    • First Alert
    • Fortrezz
    • Ge/Jasco
    • Gerber
    • Hank
    • Heatit
    • Heiman
    • Homeseer
    • Honeywell
    • Horus
    • Horus/Mco Home
    • Id Lock
    • Inovelli
    • Intermatic
    • Kichler
    • Kwikset
    • Leedarson
    • Lux
    • Monster Cable
    • Neo Coolcam
    • Nexia
    • Nodon
    • Nutone
    • Nutone
    • Philia
    • Philio
    • Poly-Control
    • Popp
    • Qubino
    • Rt
    • Remotec
    • Remotec
    • Ring
    • Satco
    • Schlage
    • Secure
    • Sensative
    • Sercomm
    • Somfy
    • Springs Window Fashions
    • Stelpro
    • Sunricher
    • Swidget
    • Telguard
    • Trane
    • Vision
    • Westinghouse
    • Wintop
    • Wintop
    • Yale
    • Z-Wave.Me
    • Zlink
    • Zipato
    • Iblinds
    • Zooz
  • Settings
    • API
      • Settings commands
      • hub.device.settings.list
      • hub.device.setting.value.set
      • hub.device.setting.dictionary.value.set
      • hub.device.setting.reset
    • Value Types
      • Setting Types
      • action
      • bool
      • int
      • rgb
      • scalable
      • token
      • array.token
      • dictionary.zwave_configuration
      • dictionary.association_group
      • dictionary.array_association
  • Device Statuses
  • Device House Modes Options
• Items
  • API
    • Items Commands
    • hub.items.list
    • hub.item.value.set (single item)
    • hub.item.value.set (multiply items with one value)
    • hub.item.value.set (different items with different values)
    • hub.item.value.percent.apply
    • hub.item.dictionary.value.add
    • hub.item.dictionary.value.set
    • hub.item.dictionary.value.remove
    • hub.item.dictionary.clear
    • Item Value Source
  • Item Names
    • Items
  • Value Types
    • Item Value Types
    • Basic types
    • Custom types
    • array
    • Scalable Types
    • Scene Value Types
    • device
    • item
    • expression
    • 24_hours_time
    • 24_hours_time_array
    • int_array
    • interval
    • hms_interval
  • Value Enumerations
    • Item Enumerations
    • Lock Operation
    • User Code Operation
    • User Code Modes
    • User Code Keypad Modes
    • Master Code States
    • Door/Window Handle State
    • Door/Window State
    • Latch State
    • Keypad State
    • Emergency State
    • Barrier Vacation Mode
    • Barrier Unattended Operation
    • Barrier Initialization
    • Barrier Safety Beam Obstacle
    • Short Circuit
    • Barrier Fail Events
    • Barrier Problem Sensors
    • Alarm Events( CO )
    • Maintenance State
    • Test State
    • Sounding Mode
    • Sound Playback
    • Periodic Inspection State
    • Alarm Events( CO2 )
    • Alarm Events( Heat )
    • Alarm Events( Siren )
    • Alarm Events( Light )
    • Light changes
    • Temperature changes
    • Water Leak Alarm
    • Water Filter Replacement Alarm
    • Water Flow Alarm
    • Water Pressure Alarm
    • Water Temperature Alarm
    • Water Level Alarm
    • Pump State
    • Alarm Sensor Events( Smoke )
    • Dust In Device( Smoke )
    • Alarm Sensor Events( Gas )
    • Intrusion State
    • Tampering Cover State
    • Glass Breakage State
    • Tampering Move State
    • Tampering Impact State
    • Tampering Invalid Code State
    • Barrier Operator Events
    • Hardware State
    • Software State
    • Emergency State
    • Digital Input State
    • Clock State
    • Tilt Binary Sensor
    • Door Lock Modes
    • Thermostat Modes
    • Thermostat Fan Modes
    • Thermostat Fan States
    • Thermostat Setpoint Modes
    • Shutter Commands
    • Thermostat Operating States
    • Shutter States
    • Color Control Capability
    • Button Actions
    • Valve State
    • Valve Current Alarm State
    • Rain State
    • Moisture State
    • Freeze State
    • Power State
    • AC State
    • Power Surge State
    • Voltage Drop/Drift State
    • Over Current State
    • Over Voltage State
    • Over Load State
    • Load Error State
    • Battery Maintenance State
    • Battery Charging State
    • Appliance Status
    • Program Status
    • Program Name
    • Program Failed Status
    • Position
    • Sleep Apnea Status
    • Sleep Stage
    • VOC Level Status
    • Week days
    • Zones Status
    • Activity
• User Functionality
  • Room Methods
    • Room APIs
    • hub.room.list
    • hub.room.create
    • hub.room.name.set
    • hub.room.order.set
    • hub.room.get
    • hub.room.delete
    • hub.room.all.delete
  • House Modes
    • House Modes commands
    • hub.modes.get
    • hub.modes.current.get
    • hub.modes.switch
    • hub.modes.cancel_switch
    • hub.modes.entry_delay.cancel
    • hub.modes.entry_delay.skip
    • hub.modes.switch_to_delay.set
    • hub.modes.alarm_delay.set
    • hub.modes.notifications.set
    • hub.modes.disarmed_default.set
    • hub.modes.disarmed_devices.add
    • hub.modes.disarmed_devices.remove
    • hub.modes.alarms_off.add
    • hub.modes.alarms_off.remove
    • hub.modes.cameras_off.add
    • hub.modes.cameras_off.remove
    • hub.modes.bypass_devices.add
    • hub.modes.bypass_devices.remove
    • hub.modes.protect.set
    • hub.modes.protect.buttons.set
    • hub.modes.protect.devices.add
    • hub.modes.protect.devices.remove
  • Scenes
    • Local Scenes API
      • Scenes General information
      • Scenes commands
      • hub.scenes.create
      • hub.scenes.get
      • hub.scenes.list
      • hub.scenes.edit
      • hub.scenes.delete
      • hub.scenes.status.get
      • hub.scenes.blocks.list
      • hub.scenes.block.data.list
      • hub.scenes.enabled.set
      • hub.scenes.notification.add
      • hub.scenes.notification.remove
      • hub.scenes.run
      • hub.scenes.room.set
      • hub.scenes.time.list
      • hub.scenes.trigger.devices.list
      • hub.scenes.icon.set
      • hub.scenes.name.set
      • hub.scenes.house_modes.set
      • hub.scenes.action.block.test
      • Scenes script related commands
      • hub.scenes.scripts.add
      • hub.scenes.scripts.set
      • hub.scenes.scripts.get
      • hub.scenes.scripts.delete
      • hub.scenes.scripts.list
      • hub.scenes.scripts.run
      • Scenes Management Commands
      • hub.scenes.block.enabled.set
      • hub.scenes.block.status.reset
      • Scenes expression related commands
      • hub.scenes.expressions.set
      • hub.scenes.expressions.delete
      • hub.scenes.expressions.list
      • hub.scenes.meta.set
      • hub.scenes.block.meta.set
    • When Blocks
      • When Blocks
      • Exception Blocks
      • Group Operations
      • Comparison Types
      • Stateful Comparison
      • Stateless Comparison
      • isItemState
      • isItemStateChanged
      • isButtonState
      • isInterval
      • isSunState
      • isDate
      • isOnce
      • isDateRange
      • isUserLockOperation
      • isHouseModeChangedTo
      • isHouseModeChangedFrom
      • IsDeviceState
      • isNetworkState
      • isSceneState
      • isGroupState
      • isCloudState
      • isBatteryState
      • isBatteryLevel
      • compareNumbers
      • compareNumberRange
      • compareStrings
      • stringOperation
      • inArray
      • compareValues
      • hasAtLeastOneDictionaryValue
      • isDictionaryChanged
      • isFirmwareUpdateState
      • isDetectedInHotzone
      • Logic operators
      • and
      • not
      • or
      • xor
      • function
      • function/for
      • function/repeat
      • function/follow
      • function/pulse
      • function/latch
    • Then Blocks
      • Then blocks
      • Else blocks
      • Action group blocks
      • Action Block Structure
      • Exceptions in Actions
      • setItemValue
      • groupSetItemValue
      • setDeviceArmed
      • groupSetDeviceArmed
      • sendCloudAbstractCommand
      • switchHouseMode
      • sendHttpRequest
      • runCustomScript
      • runPluginScript
      • runScene
      • stopScene
      • setSceneState
      • resetLatch
      • resetSceneLatches
      • rebootHub
      • resetHub
      • cloudAPI
      • setExpression
      • setVariable
      • toggleValue
      • groupToggleValue
    • Global Scenes API
      • Global Scenes
      • Global Scenes commands
      • hub.scenes.global.create
      • hub.scenes.global.list
      • hub.scenes.global.delete
      • hub.scenes.global.edit
      • hub.scenes.global.enabled.set
      • hub.scenes.global.run
    • Scenes Group Operations
      • Device Group Object
      • Item Group Object
      • Device Group commands
      • hub.scenes.device.group.create
      • hub.scenes.device.group.delete
      • hub.scenes.device.group.update
      • hub.scenes.device.groups.list
      • hub.scenes.device.group.get
      • Item Group Commands
      • hub.scenes.item.group.create
      • hub.scenes.item.group.delete
      • hub.scenes.item.group.update
      • hub.scenes.item.groups.list
      • hub.scenes.item.group.get
      • hub.scenes.device.group.find
  • Favorites
    • Favorites
    • hub.favorite.set
    • hub.favorite.list
  • Custom scripts (nodes only)
    • Plugin structure
    • interface.json
    • config.json
    • hub.custom.nodes.list
    • Installing a component
    • Uninstalling a component
    • Upgrading a component
  • Coordinates
    • Coordinates
    • hub.coordinates.set
    • hub.coordinates.get
  • Time Configuration
    • Time Configuration Commands
    • hub.time.location.set
    • hub.time.location.get
    • hub.time.location.list
  • Hub Reset
    • Hub reset
  • Network
    • Network Commands
    • hub.network.get
    • hub.network.settings.set
    • hub.network.enabled.set
    • hub.network.wifi.scan.start
    • hub.network.wifi.scan.stop
    • hub.network.wifi.try_connect
    • hub.network.wifi.try_connect.wifi.security.list
    • hub.network.wifi.try_connect.ipv4.mode.list
    • hub.network.wifi.try_connect.ipv6.mode.list
    • hub.network.wifi.up_hostap
    • hub.network.wifi.up_hostap.wifi.security.list
    • hub.network.modem.try_connect
    • hub.network.modem.pin_code.set
    • hub.network.modem.pin_code.reset
    • hub.network.modem.sim_lock.set
    • hub.network.modem.clear_fplmn
    • hub.network.modem.reregister
    • hub.network.statistics.settings.get
    • hub.network.statistics.settings.set
    • hub.network.statistics.get
    • hub.network.reset
• System
  • Local/Offline Connection
    • Local/Offline mode commands
    • hub.offline.credentials.updated
    • hub.offline.login.ui
    • hub.offline.login.hub
    • hub.offline.anonymous_access.enabled.set
    • hub.offline.insecure_access.enabled.set
  • Server
    • NMA server configuration
    • hub.server.request
  • Software
    • Software commands
    • hub.software.info.get
    • hubsoftware.update.plan
    • hubsoftware.update.execute
  • Logging
    • Hub Logging
    • hub.log.set
    • hub.log.send
    • hub.log.local.set
  • Linux controller specific
    • Linux controller specific
    • hub.ssh_tunnel.support.enabled.set
    • hub.firmware.luup.switch
    • hub.bootloader.update
    • hub.recovery_partititon.update
    • hub.ssh_tunnel.create
    • hub.ssh_tunnel.delete_all
  • Extensions
    • Extensions commands
    • hub.extensions.plugin.run
    • hub.extensions.config.list
    • hub.extensions.config.priority.set
  • Settings
    • Controller settings commands
    • Controller settings
    • hub.settings.list
    • hub.setting.value.set
  • Registration on NMA Server
    • Hub Registration on NMA Server
    • register
  • Provision
    • Update provision information
    • hub.provision_info.set
  • Access Point setup
    • Setup WiFi settings exchange protocol
    • Required IP: 192.168.4.1 Port 54540
    • Scan networks
    • Connect to network
    • Status networks
    • Finish WiFi setup
    • Restart hub
  • Backup
    • Backups
    • hub.backup.create
    • hub.backup.restore
    • hub.backups.list
  • LED Notifications
    • LED Notifications
    • Emotion LED notifications.
    • hub.led.set
  • ATOM specific
    • ATOM specific commands
    • hub.firmware.update
  • Features
    • Controller features commands
    • Software features
    • hub.features.list
    • hub.feature.status.set
  • Abstract Subscriptions
    • Cloud abstract subscriptions
    • hub.cloud.subscription.create
    • hub.cloud.subscription.update
    • hub.cloud.subscription.delete
    • hub.cloud.subscription.dispatch
    • cloud.controller_subscribe_abstracts
• Addons
  • ZWave
    • Commands
      • Z-Wave Addon Commands
      • hub.addons.zwave.nodes.provisioning.add
      • hub.addons.zwave.nodes.provisioning.set
      • hub.addons.zwave.nodes.provisioning.remove
      • hub.addons.zwave.nodes.provisioning.list
    • Broadcasts
      • Z-Wave Addon Broadcasts
      • hub.addons.zwave.nodes.provisioning.added
      • hub.addons.zwave.nodes.provisioning.updated
      • hub.addons.zwave.nodes.provisioning.removed
  • mqtt-gateway
    • MQTT Gateway Addon API
      • MQTT request message structure
      • MQTT response message structure
      • MQTT event message structure
      • mqtt.client.register
      • mqtt.client.unregister
• Plugins
  • Plugin config.json format
  • id
  • version
  • type
  • dependencies
  • permissions
  • initialize_migration
  • migration
  • finalize_migration
  • executionPolicy
  • gateway
  • extensions
  • nodes metadata
  • Plugin interface.json format
  • configuration
  • type
  • script
  • inputs
  • Input:
  • name
  • description
  • field
  • required
  • type
  • format
  • Anonymous Plugins
    • Anonymous Plugins
  • ZWave
    • Public Scripts
      • ZWave Plugin Scripts
      • scripts/start_include
      • scripts/set_authentication_mode
      • scripts/set_device_specific_key
      • scripts/stop_include
      • scripts/start_exclude
      • scripts/stop_exclude
      • scripts/start_learn
      • scripts/stop_learn
      • scripts/reconstruct_network
      • scripts/stop_security_include
      • scripts/reset
    • Broadcasts
      • ZWave Plugin Broadcasts
      • include_invoked
      • include_started
      • s2_select_authentication_modes
      • s2_request_device_specific_key
      • s2_show_device_side_key
      • include_finished
      • include_finished_error
      • include_finished_timeout
      • include_device_progress
      • rediscover_device_progress
      • exclude_invoked
      • exclude_started
      • unknown_node_removed
      • exclude_finished
      • exclude_finished_timeout
      • exclude_finished_error
      • learn_invoked
      • learn_started
      • learn_show_key
      • learn_progress
      • learn_finished
      • learn_finished_error
      • learn_finished_timeout
      • reconstruct_started
      • reconstruct_progress
      • reconstruct_finished
      • reconstruct_finished_error
      • reconstruct_progress_error
      • action_busy
      • module_reset
    • Errors
      • Z-Wave Error Messages
      • Example
      • List of error codes
    • Extensions
      • Z-Wave Extensions
      • deviceSettings
  • Zigbee
    • Public Scripts
      • Zigbee Plugin Scripts
      • scripts/start_include
      • scripts/stop_include
      • scripts/reset
      • scripts/device_remove
      • scripts/stop_fast_poll
    • Broadcasts
      • Zigbee Plugin Broadcasts
      • include_device
      • include_device_progress
      • module_reset
  • 2GIG
    • Public Scripts
      • 2GIG Plugin Scripts
      • scripts/add_device
      • scripts/start_device_discovering
      • scripts/stop_device_discovering
      • scripts/reset
    • Broadcasts
      • 2GIG Plugin Broadcasts
      • add_device
      • device_discovering
      • new_device_discovered
      • unsupported_device_discovered
  • EZVIZ
    • Plugin for Hikvision EZVIZ cameras
    • Supported models
    • Discovery
    • Streaming
    • Thumbnail
    • Camera
    • Motion sensor
  • Test Plugin
    • Public Scripts
      • Test Plugin Scripts
      • scripts/reset
      • scripts/generate_devices
      • scripts/add_device
      • scripts/modify_device
      • scripts/add_item
      • scripts/modify_item
      • scripts/add_setting
      • scripts/remove_device
      • scripts/update_item_value
      • scripts/randomize_item_values
      • scripts/stop_randomize_values
  • Siren
    • Siren Plugin
    • Siren Device
    • Siren Device Items
    • Description
  • Plugin for Ezlo Geofencing
    • Description
• Common
  • Common commands
  • hub.info.get
  • hub.reboot
  • hub.data.list
• Broadcasts
  • Hub Broadcasts
  • Description
  • hub.info.changed
  • hub.gateway.added
  • hub.gateway.updated
  • hub.gateway.removed
  • hub.device.added
  • hub.device.updated
  • hub.device.removed
  • hub.item.added
  • hub.item.updated
  • hub.item.dictionary.updated
  • hub.item.removed
  • hub.gateway.setting.added
  • hub.gateway.setting.updated
  • hub.gateway.setting.removed
  • hub.device.setting.added
  • hub.device.setting.updated
  • hub.device.setting.dictionary.updated
  • hub.device.setting.removed
  • hub.device.checked
  • hub.favorite.added
  • hub.favorite.removed
  • hub.modes.switched
  • hub.modes.notifications.notify_all
  • hub.modes.notifications.added
  • hub.modes.notifications.removed
  • hub.modes.disarmed_devices.added
  • hub.modes.disarmed_devices.removed
  • hub.modes.alarms_off.added
  • hub.modes.alarms_off.removed
  • hub.modes.cameras_off.added
  • hub.modes.cameras_off.removed
  • hub.modes.changed
  • hub.modes.protect.buttons.added
  • hub.modes.protect.buttons.updated
  • hub.modes.protect.buttons.removed
  • hub.modes.protect.devices.added
  • hub.modes.protect.devices.removed
  • hub.network.wifi.scan.progress
  • hub.network.changed
  • hub.network.modem.pin_code.enter.failed
  • hub.network.modem.pin_code.set.failed
  • hub.network.modem.pin_code.reset.failed
  • hub.network.modem.sim_lock.set.failed
  • hub.network.modem.clear_fplmn.failed
  • hub.network.modem.reregistration.failed
  • hub.network.statistics
  • hub.extensions.plugin.ui_broadcast
  • hub.extensions.plugin.run.progress
  • hub.software.update.actions
  • hub.firmware.update.progress
  • hub.software.update.progress
  • hub.backup.restore.progress
  • hub.backup.create.progress
  • hub.room.created
  • hub.room.deleted
  • hub.room.reordered
  • hub.room.edited
  • hub.scene.added
  • hub.scene.deleted
  • hub.scene.changed
  • hub.expression.added
  • hub.scene.run.progress
  • hub.scene.global.added
  • hub.scene.global.deleted
  • hub.scene.global.changed
  • hub.scene.global.run.progress
  • hub.device.firmware.download.progress
  • hub.expression.changed
  • hub.expression.deleted
  • hub.setting.updated
  • hub.log
  • hub.user.notification
  • hub.device.firmware.update.progress
  • hub.system.datetime.changed
  • hub.scenes.device.group.created
  • hub.scenes.device.group.deleted
  • hub.scenes.device.group.updated
  • hub.scenes.item.group.created
  • hub.scenes.item.group.deleted
  • hub.scenes.item.group.updated
• Gateways API
  • Gateways commands
  • hub.gateways.list
  • hub.gateway.settings.list
  • hub.gateway.setting.value.set
• HTTP-Server
  • HTTP Server
  • Requests
  • /v1/request
  • /v1/method/
  • /v1/broadcasts
  • /v1/addons/cameras/stream/snapshot/{streamId}
  • /v1/addons/cameras/stream/audio/{streamId}
  • /v1/links/plugins/{pluginName}/{linkId}
• Errors
  • errors
  • Error Object
  • General Error Codes
  • TRANSPORT_ERROR Group
  • SYSTEM_ERROR Group
  • APPLICATION_ERROR Group
  • INVALID_REQUEST Group
  • METHOD_NOT_FOUND Group
  • INVALID_PARAMS Group
  • INTERNAL_ERROR Group
  • PARSE_ERROR Group
• API Versioning
  • API Versioning
  • Versions history
• Vidoo
  • Vhub manager
    • Vhub manager
    • vhub.firmware.stop
    • vhub.firmware.start
    • vhub.status.get
    • provision.info.get
    • provision.data.new
    • provision.data.delete
    • vhub.status.changed
  • Vidoo4Hub
    • Vidoo4Hub
    • update_camera_list
    • update_object_list
    • update_people_list
    • update_hotzone_list
    • motion
    • hotzone_motion
    • request_camera_list
    • request_hotzone_list
    • request_people_list
    • request_object_list
    • take_snapshot
    • make_recording
    • stop_recording