Philip Abbey 9df93c0c23 Read only Webhook ID property
Amended some documentation.
2024-01-12 17:34:05 +00:00

93 lines
2.9 KiB
XML

<!--
Distributed under MIT Licence
See https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/LICENSE.
GarminHomeAssistant is a Garmin IQ application written in Monkey C and routinely
tested on a Venu 2 device. The source code is provided at:
https://github.com/house-of-abbey/GarminHomeAssistant.
P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
-->
<properties>
<property id="api_key" type="string"></property>
<!--
Internal URL "https://homeassistant.local/api"
External URL "https://<dynamic DNS>/api"
-->
<property id="api_url" type="string"></property>
<!--
Best be a public URL in order to work away from your
home LAN and have a trusted HTTPS certificate
-->
<property id="config_url" type="string"></property>
<!-- Decide if the menu configuration should be cached. -->
<property id="cache_config" type="boolean">false</property>
<!--
Clear the menu configuration on next application start,
and refetch, then set this back to false
-->
<property id="clear_cache" type="boolean">false</property>
<!--
Application timeout in seconds, except 0 for no
timeout (default). After this amount of elapsed
time with no activity, exit the application.
-->
<property id="app_timeout" type="number">0</property>
<!--
After this time (in seconds), a confirmation dialog
for an action is automatically closed and the action
is cancelled. Set to 0 to disable the timeout.
The default value is 3 seconds.
-->
<property id="confirm_timeout" type="number">3</property>
<!--
Lean UI with icons vs second level of menu text.
-->
<property id="menu_theme" type="number">0</property>
<!--
Left to right or right to left text. Language dependent.
-->
<property id="menu_alignment" type="number">1</property>
<!--
Widget specific setting:
As soon as the menu has been fetched start show the menu of items.
This behaviour is inconsistent with the standard Garmin User Interface,
but has been requested by users so has been made the non-default option.
-->
<property id="widget_start_no_tap" type="boolean">false</property>
<!--
Enable the background service to send the clock battery level to Home Assistant.
-->
<property id="enable_battery_level" type="boolean">false</property>
<!--
If enabled by 'enable_battery_level', the refresh rate (in minutes) at
which the background service should repeat sending the battery level.
-->
<property id="battery_level_refresh_rate" type="number">15</property>
<!--
The webhook ID is the last part of the webhook URL.
It is secret and should not be shared.
It will not be set in settings but will be
generated by the application and stored in
properties, but read only for trouble shooting.
-->
<property id="webhook_id" type="string"></property>
</properties>