diff --git a/BackgroundService.md b/BackgroundService.md
index 5311867..222370d 100644
--- a/BackgroundService.md
+++ b/BackgroundService.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# Background Service
diff --git a/HISTORY.md b/HISTORY.md
index 571d871..78897e8 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# Version History
@@ -49,5 +49,6 @@
| 3.1 | Added the ability for users to provide [custom HTTP headers](HTTP_Headers.md) for their HomeAssistant server. Improved German language translations. Thanks to [@tispokes](https://github.com/tispokes) for assisting with both of those. Removed all groups in settings as the SDK is buggy. Fixed a bug with templates in glances causing application crash on startup. |
| 3.2 | Only enable or disable sensors on HomeAssistant when the background service options is changed, i.e. do not call the API to enable on start up every time. |
| 3.3 | Providing automatic detection for menu definition updates, but still requires an application restart. |
-| 3.4 | Fixed a bug where templates failed to display in toggle menu items (at least on some devices). Fixed a bug where a menu item requesting to exit on completion appeared to indicate failure when using Wi-Fi or LTE. The fix uses a delay in exiting the application modelled as sufficient for a Venu 2 device, so this might need tweaking for other devices. Attempt to fixed an "Out of Memory" bug caused by v3.3 by making automatic checking for menu updates both optional and automatically turned off when insufficient memory is available. This last bug is device dependent and may require another attempt. Internationalisation improvements with thanks to @krzys_h for a new automated translations script. |
+| 3.4 | Fixed a bug where templates failed to display in toggle menu items (at least on some devices). Fixed a bug where a menu item requesting to exit on completion appeared to indicate failure when using Wi-Fi or LTE. The fix uses a delay in exiting the application modelled as sufficient for a Venu 2 device, so this might need tweaking for other devices. Attempt to fixed an "Out of Memory" bug caused by v3.3 by making automatic checking for menu updates both optional and automatically turned off when insufficient memory is available. This last bug is device dependent and may require another attempt. Internationalisation improvements with thanks to [@krzys_h](https://github.com/krzys-h) for a new automated translations script. |
| 3.5 | Added support for Edge 550, 850 & MTB, Fenix 8 Pro 47mm, GPSMAP H1, Instinct Crossover AMOLED, Venu 4 41mm & 45mm, & Venu X1 devices which also required an SDK update to 8.3.0. The simulation of the Edge 850 device was off, as it failed to update the display and text was the wrong colour, but the buttons menu items operated HA correctly. The assumption is the simulation model is buggy until someone [reports](https://github.com/house-of-abbey/GarminHomeAssistant/issues) otherwise. |
+| 3.6 | Added `numeric` menu item type thanks to [@thmichel](https://github.com/thmichel). This allows you to select a numeric value to set for an entity. |
diff --git a/HTTP_Headers.md b/HTTP_Headers.md
index 22d07f5..dae717e 100644
--- a/HTTP_Headers.md
+++ b/HTTP_Headers.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# User Specified Custom HTTP Headers
diff --git a/README.md b/README.md
index d7e3b91..2a9a5cb 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# GarminHomeAssistant
@@ -145,22 +145,21 @@ Example schema:
}
},
{
- "name": "Heating",
- "content": "{{ ' %.1f' | format(state_attr('climate.myheating','temperature')) }}",
- "type": "numeric",
- "entity": "climate.myheating",
- "tap_action": {
- "service": "climate.set_temperature",
- "data": {
- "step": "0.5",
- "start": "10",
- "stop": "30",
- "valueLabel": "temperature",
- "formatString": "%.1f"
- }
- },
- "pin": false
- } ,
+ "name": "Heating",
+ "content": "{{ ' %.1f' | format(state_attr('climate.room','temperature')) }}",
+ "type": "numeric",
+ "entity": "climate.room",
+ "tap_action": {
+ "service": "climate.set_temperature",
+ "picker": {
+ "step": 0.5,
+ "start": 10,
+ "stop": 30,
+ "attribute": "temperature",
+ "data_attribute": "temperature"
+ }
+ }
+ }
]
}
```
@@ -174,25 +173,28 @@ The example above illustrates how to configure:
* Script invocation (`tap`)
* Service invocation, e.g. Scene setting, (`tap`)
* A sub-menu to open (`group`)
-* A numeric item (`numeric`), which allows you to set a numeric value e.g. for heating or a dimmer. ValueLabel defines the variable to return. You can optionally set the minimum (start) and maximum (stop) value as well as the step to increase/decrease and a tepmlate how to format the value.
+* A numeric item (`numeric`), which allows you to set a numeric value e.g. for heating or a dimmer. This is [explained more fully](examples/Numeric.md) in its own examples page.
* You can also display the status of devices (`info`) which is essentially a `tap` with no action
* All menu items can display the results of evaluating [templates](examples/Templates.md).
The following table indicates how HomeAssistant entity types can map to the Garmin applications menu types. Presently, an automation is the only one that can be either a `tap` or a `toggle`.
-| HA Entity Type | Tap | Toggle | Info (status)|
-|------------------|:---:|:------:|:------------:|
-| Switch | ❌ | ✅ | ✅ |
-| Light | ❌ | ✅ | ✅ |
-| Automation | ✅ | ✅ | ❌ |
-| Script | ✅ | ❌ | ❌ |
-| Scene | ✅ | ❌ | ❌ |
-| Sensor | ❌ | ❌ | ✅ |
-| Binary Sensor | ❌ | ❌ | ✅ |
-| Any other entity | ❌ | ❌ | ✅ |
-| Any service | ✅ | ❌ | ❌ |
+| HA Entity Type | Tap | Toggle | Info (status)| Numeric |
+|------------------|:---:|:------:|:------------:|:-------:|
+| Switch | ❌ | ✅ | ✅ | ❌ |
+| Switched Light | ❌ | ✅ | ✅ | ❌ |
+| Dimmer Light | ❌ | ❌ | ✅ | ✅ |
+| Automation | ✅ | ✅ | ❌ | ❌ |
+| Script | ✅ | ❌ | ❌ | ❌ |
+| Scene | ✅ | ❌ | ❌ | ❌ |
+| Sensor | ❌ | ❌ | ✅ | ❌ |
+| Binary Sensor | ❌ | ❌ | ✅ | ❌ |
+| Thermostat | ❌ | ❌ | ✅ | ✅ |
+| Amplifier | ❌ | ❌ | ✅ | ✅ |
+| Any other entity | ❌ | ❌ | ✅ | ❌ |
+| Any service | ✅ | ❌ | ❌ | ❌ |
-Multiple templates are evaluated in a single HTTP request to update their status. Only the toggle items have the on/off 
icon. NB. All `tap` items must specify a `service` tag in the `tap_action` object (see example below).
+Multiple templates are evaluated in a single HTTP request to update their status. Only the toggle items have the on/off icon. NB. All `tap` and `numeric` items must specify a `service` tag in the `tap_action` object (see example below).
You can now specify alternative texts to use instead of "On" and "Off", e.g. "Locked" and "Unlocked" or "Open" and "Closed" through the use of a [template menu item](examples/Templates.md). But wouldn't having locks operated from your watch be a security concern ;-) ?
diff --git a/TroubleShooting.md b/TroubleShooting.md
index d01ee62..b484222 100644
--- a/TroubleShooting.md
+++ b/TroubleShooting.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# Troubleshooting Guides
diff --git a/Wi-Fi.md b/Wi-Fi.md
index dd4ca3a..311363c 100644
--- a/Wi-Fi.md
+++ b/Wi-Fi.md
@@ -1,4 +1,4 @@
-[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
+[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
# Wi-Fi & LTE
diff --git a/config.schema.json b/config.schema.json
index c639405..a696066 100644
--- a/config.schema.json
+++ b/config.schema.json
@@ -290,7 +290,8 @@
"required": [
"name",
"type",
- "entity"
+ "entity",
+ "tap_action"
],
"additionalProperties": false
},
@@ -778,7 +779,7 @@
"tap_action": {
"type": "object",
"title": "Action",
- "description": "'confirm' field is optional.",
+ "description": "'picker' field is required for 'numeric' menu type. 'confirm' and 'pin' fields are optional.",
"properties": {
"picker": {
"$ref": "#/$defs/picker"
@@ -789,6 +790,18 @@
"pin": {
"$ref": "#/$defs/pin"
}
+ },
+ "if": {
+ "properties": {
+ "type": {
+ "const": "numeric"
+ }
+ }
+ },
+ "then": {
+ "required": [
+ "picker"
+ ]
}
},
"picker": {
diff --git a/examples/Actions.md b/examples/Actions.md
index 942b264..822d46c 100644
--- a/examples/Actions.md
+++ b/examples/Actions.md
@@ -1,4 +1,4 @@
-[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
+[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Numeric](Numeric.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
# Actions
diff --git a/examples/Glance.md b/examples/Glance.md
index e48e82b..6ea2839 100644
--- a/examples/Glance.md
+++ b/examples/Glance.md
@@ -1,4 +1,4 @@
-[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
+[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Numeric](Numeric.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
# Glance
diff --git a/examples/Numeric.md b/examples/Numeric.md
new file mode 100644
index 0000000..93c4ab9
--- /dev/null
+++ b/examples/Numeric.md
@@ -0,0 +1,163 @@
+[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Numeric](Numeric.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
+
+# Numeric
+
+Provides a number picker in order to adjust a numeric value of an entity.
+
+## Thermostat
+
+An example using a thermostat as a `numeric` menu item.
+
+```json
+{
+ "name": "Heating",
+ "content": "{{ ' %.1f' | format(state_attr('climate.room','temperature')) }}",
+ "type": "numeric",
+ "entity": "climate.room",
+ "tap_action": {
+ "service": "climate.set_temperature",
+ "picker": {
+ "step": 0.5,
+ "min": 10,
+ "max": 30,
+ "attribute": "temperature",
+ "data_attribute": "temperature"
+ }
+ }
+}
+```
+
+This needs some explanation. The `tap_action` object needs a `picker` object to specify the numeric menu item's behaviour. The `picker` object is described in the table below.
+
+Field | Purpose | Mandatory |
+-----------------|----------------------------------------------------------------|-----------|
+`step` | The increment or decrement step size. | Yes |
+`min` | The minimum value the numeric entity can take. | Yes |
+`max` | The maximum value the numeric entity can take. | Yes |
+`attribute` | The attribute on the `entity` that holds the state to be read. | No |
+`data_attribute` | The attribute on the `service` call that sets the state. | Yes |
+
+It may well be the case that often `attribute` and `data_attribute` are the same attribute, as with this example.
+
+## Helper
+
+You might define a "helper" entity as follows in Home Assistant:
+
+
+
+In this case, the state is the actual value, so the template uses `states(..)` instead of `state_attr(..)`, you must not set the optional `attribute` value in the JSON definition so that the application uses the correct template internally for querying the HA server for its present value. Your own template definition in the `content` field will need to follow suit too. The `data_attribute` must be set to `value` for the service call that sets the chosen value from the number carousel.
+
+```json
+{
+ "name": "My Float",
+ "content": "Currently {{ states('input_number.my_float') }}",
+ "type": "numeric",
+ "entity": "input_number.my_float",
+ "tap_action": {
+ "service": "input_number.set_value",
+ "picker": {
+ "step": 0.5,
+ "min": -10.0,
+ "max": 10.0,
+ "data_attribute": "value"
+ }
+ }
+}
+```
+
+## Amplifier
+
+The complication here is this amplifier uses one scale for changing the value, a range 0.0 to 1.0, and another to render the volume on the display, dB. So the template does some scale conversion, but the number picker has to use the 0.0 to 1.0 range which is annoying.
+
+```json
+{
+ "name": "Amplifer Volume",
+ "content": "{{ '%.1f' | format(state_attr('media_player.amplifier','volume_level') * 100 -80) }} dB ({{ state_attr('media_player.amplifier','volume_level') }})",
+ "type": "numeric",
+ "entity": "media_player.amplifier",
+ "tap_action": {
+ "service": "media_player.volume_set",
+ "picker": {
+ "step": 0.005,
+ "min": 0.2,
+ "max": 0.6,
+ "attribute": "volume_level",
+ "data_attribute": "volume_level"
+ }
+ }
+}
+```
+
+The above is a little awkward to change the volume as the picker's scale is unfamiliar. To make life easier you might choose to implement a "Template number" in Home Assistant as defined in the following dialogue box.
+
+
+
+For copy and paste, the Jinja2 fields are as follows:
+
+1. Template rendering with conversion to dB:
+
+```
+{{ state_attr('media_player.amplifier','volume_level') * 100 -80 }}
+```
+
+2. Conversion from dB to range 0.0 to 1.0:
+
+```
+{{ (value+80)/100 }}
+```
+
+3. Availability template:
+
+```
+{{ not is_state('media_player.amplifier','unavailable') }}
+```
+
+As an alternative to using the GUI, the following can be pasted into Home Assistant's `configuration.yaml`:
+
+```yaml
+template:
+ - number:
+ - name: "Amplifier dB"
+ unique_id: ""
+ unit_of_measurement: "dB"
+ state: "{{ state_attr('media_player.amplifier','volume_level') * 100 -80 }}"
+ availability: "{{ not is_state('media_player.amplifier','unavailable') }}"
+ set_value:
+ - action: media_player.volume_set
+ target:
+ entity_id: media_player.amplifier
+ data:
+ volume_level: "{{ (value+80)/100 }}"
+ step: 0.5
+ min: -60
+ max: -15
+ icon: mdi:audio-video
+```
+
+We noticed some schema checking errors when we tried this, but the YAML above is consistent with the HA [Template](https://www.home-assistant.io/integrations/template/#number) support pages, and this code does correctly create the number template as required.
+
+The JSON menu definition can now use dB with the new template number as follows.
+
+```json
+{
+ "name": "Amplifier Volume",
+ "content": "{% if is_state('media_player.amplifier','unavailable') %}Off{% else %}{{ '%.1f' | format(states('number.amplifier_db') | float) }} dB{% endif %}",
+ "type": "numeric",
+ "entity": "number.amplifier_db",
+ "tap_action": {
+ "service": "number.set_value",
+ "picker": {
+ "step": 0.5,
+ "min": -60.0,
+ "max": -15.0,
+ "data_attribute": "value"
+ }
+ }
+},
+```
+
+## Trouble Shooting
+
+Specific to this menu item:
+
+1. If the number picker does not initialise with the correct value, amend the `attribute` field. Just because your template renders does not mean the application has extracted the numeric value as the `content` template is rendered on the Home Assistant server.
diff --git a/examples/Switches.md b/examples/Switches.md
index c5834d4..3f9bc23 100644
--- a/examples/Switches.md
+++ b/examples/Switches.md
@@ -1,4 +1,4 @@
-[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
+[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Numeric](Numeric.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
# Switches
diff --git a/examples/Templates.md b/examples/Templates.md
index 92132e0..bc18205 100644
--- a/examples/Templates.md
+++ b/examples/Templates.md
@@ -1,4 +1,4 @@
-[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
+[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | [Templates](Templates.md) | [Numeric](Numeric.md) | [Glance](Glance.md) | [Background Service](../BackgroundService.md) | [Wi-Fi](../Wi-Fi.md) | [HTTP Headers](../HTTP_Headers.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md)
# Templates
diff --git a/images/my_float.png b/images/my_float.png
new file mode 100644
index 0000000..8411668
Binary files /dev/null and b/images/my_float.png differ
diff --git a/images/template_number.png b/images/template_number.png
new file mode 100644
index 0000000..335f265
Binary files /dev/null and b/images/template_number.png differ
diff --git a/manifest.xml b/manifest.xml
index 2831ff2..c6fe151 100644
--- a/manifest.xml
+++ b/manifest.xml
@@ -24,7 +24,7 @@
Use "Monkey C: Edit Application" from the Visual Studio Code command palette
to update the application attributes.
-->
-
+