core/homeassistant/components/zwave_js/services.yaml

90 lines
2.2 KiB
YAML

# Describes the format for available Z-Wave services
clear_lock_usercode:
name: Clear a usercode from a lock
description: Clear a usercode from a lock
target:
entity:
domain: lock
integration: zwave_js
fields:
code_slot:
name: Code slot
description: Code slot to clear code from
required: true
example: 1
selector:
text:
set_lock_usercode:
name: Set a usercode on a lock
description: Set a usercode on a lock
target:
entity:
domain: lock
integration: zwave_js
fields:
code_slot:
name: Code slot
description: Code slot to set the code.
required: true
example: 1
selector:
text:
usercode:
name: Code
description: Code to set.
required: true
example: 1234
selector:
text:
set_config_parameter:
name: Set a Z-Wave device configuration parameter
description: Allow for changing configuration parameters of your Z-Wave devices.
target:
entity:
integration: zwave_js
fields:
parameter:
name: Parameter
description: The (name or id of the) configuration parameter you want to configure.
example: Minimum brightness level
required: true
selector:
text:
value:
name: Value
description: The new value to set for this configuration parameter.
example: 5
required: true
selector:
object:
bitmask:
name: Bitmask
description: Target a specific bitmask (see the documentation for more information).
advanced: true
selector:
object:
refresh_value:
name: Refresh value(s) of a Z-Wave entity
description: Force update value(s) for a Z-Wave entity
fields:
entity_id:
name: Entity
description: Entity whose value(s) should be refreshed
required: true
example: sensor.family_room_motion
selector:
entity:
integration: zwave_js
refresh_all_values:
name: Refresh all values?
description: Whether to refresh all values (true) or just the primary value (false)
required: false
example: true
default: false
selector:
boolean: