public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[homekit] simplify settings page, resize doc images (#13741) 

* simplify config, resize images

Signed-off-by: Eugen <eugen@relotrust.com>
This commit is contained in:
eugen 2022-11-20 20:07:45 +01:00 committed by GitHub
parent 34b2cead83
commit 54e934be3d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 53 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bundles/org.openhab.io.homekit/README.md
View File

@ -100,11 +100,13 @@ org.openhab.homekit:name=openHAB
org.openhab.homekit:instances=1
```
Some settings are only visible in UI if the checkbox "Show advanced" is activated.
### Overview of all settings
| Setting | Description | Default value |
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|
| networkInterface | IP address or domain name under which the HomeKit bridge can be reached. If no value is configured, the add-on uses the first network adapter address configured for openHAB. | (none) |
|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|
| networkInterface | IP address or domain name under which the HomeKit bridge can be reached. If no value is configured, the add-on uses the primary IP address configured for openHAB. If unsure, keep it empty | (none) |
| port | Port under which the HomeKit bridge can be reached. | 9123 |
| useOHmDNS | mDNS service is used to advertise openHAB as HomeKit bridge in the network so that HomeKit clients can find it. openHAB has already mDNS service running. This option defines whether the mDNS service of openHAB or a separate service should be used. | false |
| blockUserDeletion | Blocks HomeKit user deletion in openHAB and as result unpairing of devices. If you experience an issue with accessories becoming non-responsive after some time, try to enable this setting. You can also enable this setting if your HomeKit setup is done and you will not re-pair ios devices. | false |

BIN
bundles/org.openhab.io.homekit/doc/mode_mapping.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 26 KiB

BIN
bundles/org.openhab.io.homekit/doc/sensor_ui_config.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 19 KiB

BIN
bundles/org.openhab.io.homekit/doc/settings_qrcode.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 107 KiB

After

Width:  |  Height:  |  Size: 53 KiB

BIN
bundles/org.openhab.io.homekit/doc/ui_fan_with_light_group_code.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 16 KiB

BIN
bundles/org.openhab.io.homekit/doc/ui_fan_with_light_group_config.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 25 KiB

BIN
bundles/org.openhab.io.homekit/doc/ui_fan_with_light_group_view.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 42 KiB

BIN
bundles/org.openhab.io.homekit/doc/ui_fan_with_light_primary.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 18 KiB

BIN
bundles/org.openhab.io.homekit/doc/ui_sensor_with_battery.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 84 KiB

40
bundles/org.openhab.io.homekit/src/main/resources/OH-INF/config/config.xml
View File

@ -6,29 +6,33 @@
https://openhab.org/schemas/config-description-1.0.0.xsd">
<config-description uri="io:homekit">
<parameter-group name="core">
<label>Core Configuration</label>
<label>Core Configuration.</label>
<advanced>false</advanced>
</parameter-group>
<parameter-group name="thermostat">
<label>Thermostat Settings</label>
<description>General thermostat settings</description>
<description>Advanced thermostat settings.</description>
<advanced>true</advanced>
</parameter-group>
<parameter-group name="network">
<label>Network Settings</label>
<description>General network settings</description>
<description>Advanced network settings.</description>
<advanced>true</advanced>
</parameter-group>
<parameter-group name="thermostatTargetHeatingCooling">
<label>Thermostat Target Heating/Cooling Mapping</label>
<description>String values used by your thermostat to set different targetHeatingCooling modes</description>
<description>String values used by your thermostat to set different target heating/cooling modes.</description>
<advanced>true</advanced>
</parameter-group>
<parameter-group name="thermostatCurrentHeatingCooling">
<label>Thermostat Current Heating/Cooling Mapping</label>
<description>String values used by your thermostat to set different targetHeatingCooling modes</description>
<description>String values used by your thermostat to set different current heating/cooling modes.</description>
<advanced>true</advanced>
</parameter-group>
<parameter name="name" type="text" required="false" groupName="core">
<label>Bridge name</label>
<description>Name of the HomeKit bridge</description>
<description>Name of the HomeKit bridge.</description>
<default>openHAB</default>
</parameter>
<parameter name="qrCode" type="text" required="false" groupName="core">
@ -36,16 +40,18 @@
<context>qrcode</context>
<description>Scan QR code with home app to add openHAB as HomeKit bridge.</description>
</parameter>
<parameter name="port" type="integer" required="true" groupName="core">
<parameter name="port" type="integer" required="true" groupName="network">
<label>Port</label>
<description>Defines the port the HomeKit integration listens on.</description>
<default>9123</default>
<advanced>true</advanced>
</parameter>
<parameter name="instances" type="integer" required="true" groupName="core">
<label>Instances</label>
<description>Defines how many bridges to expose. Necessary if you have more than 149 accessories. Accessories must be
assigned to additional instances via metadata. Additional bridges will use incrementing port numbers.</description>
<default>1</default>
<advanced>true</advanced>
</parameter>
<parameter name="pin" type="text" pattern="\d{3}-\d{2}-\d{3}" required="true" groupName="core">
<label>Pin</label>
@ -55,53 +61,59 @@
<parameter name="setupId" type="text" pattern="[0-9A-Z]{4}" required="false" groupName="core">
<label>Setup ID</label>
<description>Setup ID used for pairing using QR Code. Alphanumeric code of length 4.</description>
<advanced>true</advanced>
</parameter>
<parameter name="networkInterface" type="text" required="false" groupName="network">
<label>Network Interface</label>
<description>Defines the IP address of the network interface to expose the HomeKit integration on.</description>
<advanced>true</advanced>
</parameter>
<parameter name="startDelay" type="integer" required="true" groupName="core" unit="s">
<label>Start Delay</label>
<description>HomeKit start delay in case of item configuration differences.</description>
<default>30</default>
<advanced>true</advanced>
</parameter>
<parameter name="useFahrenheitTemperature" type="boolean" required="true" groupName="thermostat">
<label>Use Fahrenheit Temperature</label>
<description>Defines whether or not to direct HomeKit clients to use fahrenheit temperatures instead of celsius.</description>
<default>false</default>
</parameter>
<parameter name="thermostatTargetModeCool" type="text" required="true"
groupName="thermostatTargetHeatingCooling">
<label>Cool Value</label>
<description>Word used to set the target heatingCoolingMode to COOL (if a thermostat is defined).</description>
<default>CoolOn</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatTargetModeHeat" type="text" required="true"
groupName="thermostatTargetHeatingCooling">
<label>Heat Value</label>
<description>Word used to set the target heatingCoolingMode to HEAT (if a thermostat is defined).</description>
<default>HeatOn</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatTargetModeAuto" type="text" required="true"
groupName="thermostatTargetHeatingCooling">
<label>Auto Value</label>
<description>Word used to set the target heatingCoolingMode to AUTO (if a thermostat is defined).</description>
<default>Auto</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatTargetModeOff" type="text" required="true"
groupName="thermostatTargetHeatingCooling">
<label>Off Value</label>
<description>Word used to set the target heatingCoolingMode to OFF (if a thermostat is defined).</description>
<default>Off</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatCurrentModeHeating" type="text" required="true"
groupName="thermostatCurrentHeatingCooling">
<label>Heating Value</label>
<description>Value for setting target heatingCoolingCurrentMode to HEAT (IE: indicating that the heater is currently
warming the home).</description>
<default>Heating</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatCurrentModeCooling" type="text" required="true"
groupName="thermostatCurrentHeatingCooling">
@ -109,6 +121,7 @@
<description>Value for setting target heatingCoolingCurrentMode to COOL (IE: indicating that the air condition is
currently cooling the home).</description>
<default>Cooling</default>
<advanced>true</advanced>
</parameter>
<parameter name="thermostatCurrentModeOff" type="text" required="true"
groupName="thermostatCurrentHeatingCooling">
@ -116,16 +129,19 @@
<description>Value for setting target heatingCoolingCurrentMode to OFF (IE: the hvac is currently idle, because the
target temperature has been reached per the mode).</description>
<default>Off</default>
<advanced>true</advanced>
</parameter>
<parameter name="useOHmDNS" type="boolean" required="false" groupName="network">
<label>Use openHAB mDNS service</label>
<description>Defines whether mDNS service of openHAB or a separate instance of mDNS should be used.</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
<parameter name="blockUserDeletion" type="boolean" required="false" groupName="network">
<parameter name="blockUserDeletion" type="boolean" required="false" groupName="core">
<label>Block deletion of the HomeKit user</label>
<description>Block deletion of the HomeKit user information from openHAB and the unpairing of devices</description>
<description>Block deletion of the HomeKit user information from openHAB and the unpairing of devices.</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
</config-description>
</config-description:config-descriptions>

14
bundles/org.openhab.io.homekit/src/main/resources/OH-INF/i18n/homekit.properties
View File

@ -1,18 +1,18 @@
io.config.homekit.blockUserDeletion.label = Block deletion of the HomeKit user
io.config.homekit.blockUserDeletion.description = Block deletion of the HomeKit user information from openHAB and the unpairing of devices
io.config.homekit.group.core.label = Core Configuration
io.config.homekit.blockUserDeletion.description = Block deletion of the HomeKit user information from openHAB and the unpairing of devices.
io.config.homekit.group.core.label = Core Configuration.
io.config.homekit.group.network.label = Network Settings
io.config.homekit.group.network.description = General network settings
io.config.homekit.group.network.description = Advanced network settings.
io.config.homekit.group.thermostat.label = Thermostat Settings
io.config.homekit.group.thermostat.description = General thermostat settings
io.config.homekit.group.thermostat.description = Advanced thermostat settings.
io.config.homekit.group.thermostatCurrentHeatingCooling.label = Thermostat Current Heating/Cooling Mapping
io.config.homekit.group.thermostatCurrentHeatingCooling.description = String values used by your thermostat to set different targetHeatingCooling modes
io.config.homekit.group.thermostatCurrentHeatingCooling.description = String values used by your thermostat to set different current heating/cooling modes.
io.config.homekit.group.thermostatTargetHeatingCooling.label = Thermostat Target Heating/Cooling Mapping
io.config.homekit.group.thermostatTargetHeatingCooling.description = String values used by your thermostat to set different targetHeatingCooling modes
io.config.homekit.group.thermostatTargetHeatingCooling.description = String values used by your thermostat to set different target heating/cooling modes.
io.config.homekit.instances.label = Instances
io.config.homekit.instances.description = Defines how many bridges to expose. Necessary if you have more than 149 accessories. Accessories must be assigned to additional instances via metadata. Additional bridges will use incrementing port numbers.
io.config.homekit.name.label = Bridge name
io.config.homekit.name.description = Name of the HomeKit bridge
io.config.homekit.name.description = Name of the HomeKit bridge.
io.config.homekit.networkInterface.label = Network Interface
io.config.homekit.networkInterface.description = Defines the IP address of the network interface to expose the HomeKit integration on.
io.config.homekit.pin.label = Pin