From e95c4f7e65f9d6dbc6df868ba1b78cff36712eac Mon Sep 17 00:00:00 2001
From: Franck Nijhof <git@frenck.dev>
Date: Wed, 12 Jul 2023 20:49:36 +0200
Subject: [PATCH] Migrate zha services to support translations (#96418)
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
---
homeassistant/components/zha/services.yaml | 132 -----------
homeassistant/components/zha/strings.json | 262 ++++++++++++++++++++-
2 files changed, 260 insertions(+), 134 deletions(-)
diff --git a/homeassistant/components/zha/services.yaml b/homeassistant/components/zha/services.yaml
index 132dae6e745..027653a4a6f 100644
--- a/homeassistant/components/zha/services.yaml
+++ b/homeassistant/components/zha/services.yaml
@@ -1,12 +1,8 @@
# Describes the format for available zha services
permit:
- name: Permit
- description: Allow nodes to join the Zigbee network.
fields:
duration:
- name: Duration
- description: Time to permit joins, in seconds
default: 60
selector:
number:
@@ -14,73 +10,46 @@ permit:
max: 254
unit_of_measurement: seconds
ieee:
- name: IEEE
- description: IEEE address of the node permitting new joins
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
source_ieee:
- name: Source IEEE
- description: IEEE address of the joining device (must be used with install code)
example: "00:0a:bf:00:01:10:23:35"
selector:
text:
install_code:
- name: Install Code
- description: Install code of the joining device (must be used with source_ieee)
example: "1234-5678-1234-5678-AABB-CCDD-AABB-CCDD-EEFF"
selector:
text:
qr_code:
- name: QR Code
- description: value of the QR install code (different between vendors)
example: "Z:000D6FFFFED4163B$I:52797BF4A5084DAA8E1712B61741CA024051"
selector:
text:
remove:
- name: Remove
- description: Remove a node from the Zigbee network.
fields:
ieee:
- name: IEEE
- description: IEEE address of the node to remove
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
reconfigure_device:
- name: Reconfigure device
- description: >-
- Reconfigure ZHA device (heal device). Use this if you are having issues
- with the device. If the device in question is a battery powered device
- please ensure it is awake and accepting commands when you use this
- service.
fields:
ieee:
- name: IEEE
- description: IEEE address of the device to reconfigure
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
set_zigbee_cluster_attribute:
- name: Set zigbee cluster attribute
- description: >-
- Set attribute value for the specified cluster on the specified entity.
fields:
ieee:
- name: IEEE
- description: IEEE address for the device
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
endpoint_id:
- name: Endpoint ID
- description: Endpoint id for the cluster
required: true
selector:
number:
@@ -88,16 +57,12 @@ set_zigbee_cluster_attribute:
max: 65535
mode: box
cluster_id:
- name: Cluster ID
- description: ZCL cluster to retrieve attributes for
required: true
selector:
number:
min: 1
max: 65535
cluster_type:
- name: Cluster Type
- description: type of the cluster
default: "in"
selector:
select:
@@ -105,8 +70,6 @@ set_zigbee_cluster_attribute:
- "in"
- "out"
attribute:
- name: Attribute
- description: id of the attribute to set
required: true
example: 0
selector:
@@ -114,50 +77,35 @@ set_zigbee_cluster_attribute:
min: 1
max: 65535
value:
- name: Value
- description: value to write to the attribute
required: true
example: 0x0001
selector:
text:
manufacturer:
- name: Manufacturer
- description: manufacturer code
example: 0x00FC
selector:
text:
issue_zigbee_cluster_command:
- name: Issue zigbee cluster command
- description: >-
- Issue command on the specified cluster on the specified entity.
fields:
ieee:
- name: IEEE
- description: IEEE address for the device
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
endpoint_id:
- name: Endpoint ID
- description: Endpoint id for the cluster
required: true
selector:
number:
min: 1
max: 65535
cluster_id:
- name: Cluster ID
- description: ZCL cluster to retrieve attributes for
required: true
selector:
number:
min: 1
max: 65535
cluster_type:
- name: Cluster Type
- description: type of the cluster
default: "in"
selector:
select:
@@ -165,16 +113,12 @@ issue_zigbee_cluster_command:
- "in"
- "out"
command:
- name: Command
- description: id of the command to execute
required: true
selector:
number:
min: 1
max: 65535
command_type:
- name: Command Type
- description: type of the command to execute
required: true
selector:
select:
@@ -182,46 +126,31 @@ issue_zigbee_cluster_command:
- "client"
- "server"
args:
- name: Args
- description: args to pass to the command
example: "[arg1, arg2, argN]"
selector:
object:
params:
- name: Params
- description: parameters to pass to the command
selector:
object:
manufacturer:
- name: Manufacturer
- description: manufacturer code
example: 0x00FC
selector:
text:
issue_zigbee_group_command:
- name: Issue zigbee group command
- description: >-
- Issue command on the specified cluster on the specified group.
fields:
group:
- name: Group
- description: Hexadecimal address of the group
required: true
example: 0x0222
selector:
text:
cluster_id:
- name: Cluster ID
- description: ZCL cluster to send command to
required: true
selector:
number:
min: 1
max: 65535
cluster_type:
- name: Cluster Type
- description: type of the cluster
default: "in"
selector:
select:
@@ -229,42 +158,28 @@ issue_zigbee_group_command:
- "in"
- "out"
command:
- name: Command
- description: id of the command to execute
required: true
selector:
number:
min: 1
max: 65535
args:
- name: Args
- description: args to pass to the command
example: "[arg1, arg2, argN]"
selector:
object:
manufacturer:
- name: Manufacturer
- description: manufacturer code
example: 0x00FC
selector:
text:
warning_device_squawk:
- name: Warning device squawk
- description: >-
- This service uses the WD capabilities to emit a quick audible/visible pulse called a "squawk". The squawk command has no effect if the WD is currently active (warning in progress).
fields:
ieee:
- name: IEEE
- description: IEEE address for the device
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
mode:
- name: Mode
- description: >-
- The Squawk Mode field is used as a 4-bit enumeration, and can have one of the values shown in Table 8-24 of the ZCL spec - Squawk Mode Field. The exact operation of each mode (how the WD “squawks”) is implementation specific.
default: 0
selector:
number:
@@ -272,9 +187,6 @@ warning_device_squawk:
max: 1
mode: box
strobe:
- name: Strobe
- description: >-
- The strobe field is used as a Boolean, and determines if the visual indication is also required in addition to the audible squawk, as shown in Table 8-25 of the ZCL spec - Strobe Bit.
default: 1
selector:
number:
@@ -282,9 +194,6 @@ warning_device_squawk:
max: 1
mode: box
level:
- name: Level
- description: >-
- The squawk level field is used as a 2-bit enumeration, and determines the intensity of audible squawk sound as shown in Table 8-26 of the ZCL spec - Squawk Level Field Values.
default: 2
selector:
number:
@@ -293,21 +202,13 @@ warning_device_squawk:
mode: box
warning_device_warn:
- name: Warning device warn
- description: >-
- This service starts the WD operation. The WD alerts the surrounding area by audible (siren) and visual (strobe) signals.
fields:
ieee:
- name: IEEE
- description: IEEE address for the device
required: true
example: "00:0d:6f:00:05:7d:2d:34"
selector:
text:
mode:
- name: Mode
- description: >-
- The Warning Mode field is used as an 4-bit enumeration, can have one of the values 0-6 defined below in table 8-20 of the ZCL spec. The exact behavior of the WD device in each mode is according to the relevant security standards.
default: 3
selector:
number:
@@ -315,9 +216,6 @@ warning_device_warn:
max: 6
mode: box
strobe:
- name: Strobe
- description: >-
- The Strobe field is used as a 2-bit enumeration, and determines if the visual indication is required in addition to the audible siren, as indicated in Table 8-21 of the ZCL spec. "0" means no strobe, "1" means strobe. If the strobe field is “1” and the Warning Mode is “0” (“Stop”) then only the strobe is activated.
default: 1
selector:
number:
@@ -325,9 +223,6 @@ warning_device_warn:
max: 1
mode: box
level:
- name: Level
- description: >-
- The Siren Level field is used as a 2-bit enumeration, and indicates the intensity of audible squawk sound as shown in Table 8-22 of the ZCL spec.
default: 2
selector:
number:
@@ -335,9 +230,6 @@ warning_device_warn:
max: 3
mode: box
duration:
- name: Duration
- description: >-
- Requested duration of warning, in seconds (16 bit). If both Strobe and Warning Mode are "0" this field SHALL be ignored.
default: 5
selector:
number:
@@ -345,9 +237,6 @@ warning_device_warn:
max: 65535
unit_of_measurement: seconds
duty_cycle:
- name: Duty cycle
- description: >-
- Indicates the length of the flash cycle. This provides a means of varying the flash duration for different alarm types (e.g., fire, police, burglar). Valid range is 0-100 in increments of 10. All other values SHALL be rounded to the nearest valid value. Strobe SHALL calculate duty cycle over a duration of one second. The ON state SHALL precede the OFF state. For example, if Strobe Duty Cycle Field specifies “40,” then the strobe SHALL flash ON for 4/10ths of a second and then turn OFF for 6/10ths of a second.
default: 0
selector:
number:
@@ -355,9 +244,6 @@ warning_device_warn:
max: 100
step: 10
intensity:
- name: Intensity
- description: >-
- Indicates the intensity of the strobe as shown in Table 8-23 of the ZCL spec. This attribute is designed to vary the output of the strobe (i.e., brightness) and not its frequency, which is detailed in section 8.4.2.3.1.6 of the ZCL spec.
default: 2
selector:
number:
@@ -366,71 +252,53 @@ warning_device_warn:
mode: box
clear_lock_user_code:
- name: Clear lock user
- description: Clear a user code from a lock
target:
entity:
domain: lock
integration: zha
fields:
code_slot:
- name: Code slot
- description: Code slot to clear code from
required: true
example: 1
selector:
text:
enable_lock_user_code:
- name: Enable lock user
- description: Enable a user code on a lock
target:
entity:
domain: lock
integration: zha
fields:
code_slot:
- name: Code slot
- description: Code slot to enable
required: true
example: 1
selector:
text:
disable_lock_user_code:
- name: Disable lock user
- description: Disable a user code on a lock
target:
entity:
domain: lock
integration: zha
fields:
code_slot:
- name: Code slot
- description: Code slot to disable
required: true
example: 1
selector:
text:
set_lock_user_code:
- name: Set lock user code
- description: Set a user code on a lock
target:
entity:
domain: lock
integration: zha
fields:
code_slot:
- name: Code slot
- description: Code slot to set the code in
required: true
example: 1
selector:
text:
user_code:
- name: Code
- description: Code to set
required: true
example: 1234
selector:
diff --git a/homeassistant/components/zha/strings.json b/homeassistant/components/zha/strings.json
index cbdc9cf8477..efc71df7adc 100644
--- a/homeassistant/components/zha/strings.json
+++ b/homeassistant/components/zha/strings.json
@@ -4,7 +4,9 @@
"step": {
"choose_serial_port": {
"title": "Select a Serial Port",
- "data": { "path": "Serial Device Path" },
+ "data": {
+ "path": "Serial Device Path"
+ },
"description": "Select the serial port for your Zigbee radio"
},
"confirm": {
@@ -14,7 +16,9 @@
"description": "Do you want to set up {name}?"
},
"manual_pick_radio_type": {
- "data": { "radio_type": "Radio Type" },
+ "data": {
+ "radio_type": "Radio Type"
+ },
"title": "Radio Type",
"description": "Pick your Zigbee radio type"
},
@@ -244,5 +248,259 @@
"face_5": "With face 5 activated",
"face_6": "With face 6 activated"
}
+ },
+ "services": {
+ "permit": {
+ "name": "Permit",
+ "description": "Allows nodes to join the Zigbee network.",
+ "fields": {
+ "duration": {
+ "name": "Duration",
+ "description": "Time to permit joins."
+ },
+ "ieee": {
+ "name": "IEEE",
+ "description": "IEEE address of the node permitting new joins."
+ },
+ "source_ieee": {
+ "name": "Source IEEE",
+ "description": "IEEE address of the joining device (must be used with the install code)."
+ },
+ "install_code": {
+ "name": "Install code",
+ "description": "Install code of the joining device (must be used with the source_ieee)."
+ },
+ "qr_code": {
+ "name": "QR code",
+ "description": "Value of the QR install code (different between vendors)."
+ }
+ }
+ },
+ "remove": {
+ "name": "Remove",
+ "description": "Removes a node from the Zigbee network.",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "IEEE address of the node to remove."
+ }
+ }
+ },
+ "reconfigure_device": {
+ "name": "Reconfigure device",
+ "description": "Reconfigures a ZHA device (heal device). Use this if you are having issues with the device. If the device in question is a battery-powered device, ensure it is awake and accepting commands when you use this service.",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "IEEE address of the device to reconfigure."
+ }
+ }
+ },
+ "set_zigbee_cluster_attribute": {
+ "name": "Set zigbee cluster attribute",
+ "description": "Sets an attribute value for the specified cluster on the specified entity.",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "IEEE address for the device."
+ },
+ "endpoint_id": {
+ "name": "Endpoint ID",
+ "description": "Endpoint ID for the cluster."
+ },
+ "cluster_id": {
+ "name": "Cluster ID",
+ "description": "ZCL cluster to retrieve attributes for."
+ },
+ "cluster_type": {
+ "name": "Cluster Type",
+ "description": "Type of the cluster."
+ },
+ "attribute": {
+ "name": "Attribute",
+ "description": "ID of the attribute to set."
+ },
+ "value": {
+ "name": "Value",
+ "description": "Value to write to the attribute."
+ },
+ "manufacturer": {
+ "name": "Manufacturer",
+ "description": "Manufacturer code."
+ }
+ }
+ },
+ "issue_zigbee_cluster_command": {
+ "name": "Issue zigbee cluster command",
+ "description": "Issues a command on the specified cluster on the specified entity.",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::ieee::description%]"
+ },
+ "endpoint_id": {
+ "name": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::endpoint_id::name%]",
+ "description": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::endpoint_id::description%]"
+ },
+ "cluster_id": {
+ "name": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::cluster_id::name%]",
+ "description": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::cluster_id::description%]"
+ },
+ "cluster_type": {
+ "name": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::cluster_type::name%]",
+ "description": "[%key:component::zha::services::set_zigbee_cluster_attribute::fields::cluster_type::description%]"
+ },
+ "command": {
+ "name": "Command",
+ "description": "ID of the command to execute."
+ },
+ "command_type": {
+ "name": "Command Type",
+ "description": "Type of the command to execute."
+ },
+ "args": {
+ "name": "Args",
+ "description": "Arguments to pass to the command."
+ },
+ "params": {
+ "name": "Params",
+ "description": "Parameters to pass to the command."
+ },
+ "manufacturer": {
+ "name": "Manufacturer",
+ "description": "Manufacturer code."
+ }
+ }
+ },
+ "issue_zigbee_group_command": {
+ "name": "Issue zigbee group command",
+ "description": "Issue command on the specified cluster on the specified group.",
+ "fields": {
+ "group": {
+ "name": "Group",
+ "description": "Hexadecimal address of the group."
+ },
+ "cluster_id": {
+ "name": "Cluster ID",
+ "description": "ZCL cluster to send command to."
+ },
+ "cluster_type": {
+ "name": "Cluster type",
+ "description": "Type of the cluster."
+ },
+ "command": {
+ "name": "Command",
+ "description": "ID of the command to execute."
+ },
+ "args": {
+ "name": "Args",
+ "description": "Arguments to pass to the command."
+ },
+ "manufacturer": {
+ "name": "Manufacturer",
+ "description": "Manufacturer code."
+ }
+ }
+ },
+ "warning_device_squawk": {
+ "name": "Warning device squawk",
+ "description": "This service uses the WD capabilities to emit a quick audible/visible pulse called a \"squawk\". The squawk command has no effect if the WD is currently active (warning in progress).",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "IEEE address for the device."
+ },
+ "mode": {
+ "name": "Mode",
+ "description": "The Squawk Mode field is used as a 4-bit enumeration, and can have one of the values shown in Table 8-24 of the ZCL spec - Squawk Mode Field. The exact operation of each mode (how the WD \u201csquawks\u201d) is implementation specific."
+ },
+ "strobe": {
+ "name": "Strobe",
+ "description": "The strobe field is used as a Boolean, and determines if the visual indication is also required in addition to the audible squawk, as shown in Table 8-25 of the ZCL spec - Strobe Bit."
+ },
+ "level": {
+ "name": "Level",
+ "description": "The squawk level field is used as a 2-bit enumeration, and determines the intensity of audible squawk sound as shown in Table 8-26 of the ZCL spec - Squawk Level Field Values."
+ }
+ }
+ },
+ "warning_device_warn": {
+ "name": "Warning device warn",
+ "description": "This service starts the WD operation. The WD alerts the surrounding area by audible (siren) and visual (strobe) signals.",
+ "fields": {
+ "ieee": {
+ "name": "[%key:component::zha::services::permit::fields::ieee::name%]",
+ "description": "IEEE address for the device."
+ },
+ "mode": {
+ "name": "Mode",
+ "description": "The Warning Mode field is used as an 4-bit enumeration, can have one of the values 0-6 defined below in table 8-20 of the ZCL spec. The exact behavior of the WD device in each mode is according to the relevant security standards."
+ },
+ "strobe": {
+ "name": "Strobe",
+ "description": "The Strobe field is used as a 2-bit enumeration, and determines if the visual indication is required in addition to the audible siren, as indicated in Table 8-21 of the ZCL spec. \"0\" means no strobe, \"1\" means strobe. If the strobe field is \u201c1\u201d and the Warning Mode is \u201c0\u201d (\u201cStop\u201d) then only the strobe is activated."
+ },
+ "level": {
+ "name": "Level",
+ "description": "The Siren Level field is used as a 2-bit enumeration, and indicates the intensity of audible squawk sound as shown in Table 8-22 of the ZCL spec."
+ },
+ "duration": {
+ "name": "Duration",
+ "description": "Requested duration of warning, in seconds (16 bit). If both Strobe and Warning Mode are \"0\" this field SHALL be ignored."
+ },
+ "duty_cycle": {
+ "name": "Duty cycle",
+ "description": "Indicates the length of the flash cycle. This allows you to vary the flash duration for different alarm types (e.g., fire, police, burglar). The valid range is 0-100 in increments of 10. All other values must be rounded to the nearest valid value. Strobe calculates a duty cycle over a duration of one second. The ON state must precede the OFF state. For example, if Strobe Duty Cycle Field specifies \u201c40,\u201d, then the strobe flashes ON for 4/10ths of a second and then turns OFF for 6/10ths of a second."
+ },
+ "intensity": {
+ "name": "Intensity",
+ "description": "Indicates the intensity of the strobe as shown in Table 8-23 of the ZCL spec. This attribute is designed to vary the output of the strobe (i.e., brightness) and not its frequency, which is detailed in section 8.4.2.3.1.6 of the ZCL spec."
+ }
+ }
+ },
+ "clear_lock_user_code": {
+ "name": "Clear lock user",
+ "description": "Clears a user code from a lock.",
+ "fields": {
+ "code_slot": {
+ "name": "Code slot",
+ "description": "Code slot to clear code from."
+ }
+ }
+ },
+ "enable_lock_user_code": {
+ "name": "Enable lock user",
+ "description": "Enables a user code on a lock.",
+ "fields": {
+ "code_slot": {
+ "name": "[%key:component::zha::services::clear_lock_user_code::fields::code_slot::name%]",
+ "description": "Code slot to enable."
+ }
+ }
+ },
+ "disable_lock_user_code": {
+ "name": "Disable lock user",
+ "description": "Disables a user code on a lock.",
+ "fields": {
+ "code_slot": {
+ "name": "[%key:component::zha::services::clear_lock_user_code::fields::code_slot::name%]",
+ "description": "Code slot to disable."
+ }
+ }
+ },
+ "set_lock_user_code": {
+ "name": "Set lock user code",
+ "description": "Sets a user code on a lock.",
+ "fields": {
+ "code_slot": {
+ "name": "[%key:component::zha::services::clear_lock_user_code::fields::code_slot::name%]",
+ "description": "Code slot to set the code in."
+ },
+ "user_code": {
+ "name": "Code",
+ "description": "Code to set."
+ }
+ }
+ }
}
}