Compare commits

...

21 Commits

Author SHA1 Message Date
Joseph Abbey
75045b19d9 Fix for numeric menu items over Wi-Fi/LTE (#318)
Turns out the sync service will not run unless the picker has not only
been popped but the display also updated.

v3.7 needs a swift turnaround as its a bug reported by a user.
2025-11-07 23:23:42 +00:00
Philip Abbey
d6e32b777f Update HISTORY.md
Added v3.7 text.
2025-11-07 09:10:47 +00:00
Philip Abbey
1e17d93310 Fix for numeric menu items over Wi-Fi/LTE
Turns out the sync service will not run unless the picker has not only been popped but the display also updated.
2025-11-07 09:05:22 +00:00
Philip Abbey
cc53b25508 Update HomeAssistantTapMenuItem.mc
Code tidy only.
2025-11-07 09:03:05 +00:00
Philip Abbey
098dc81236 Space alignment in code (tidy) and v3.6 history amendment 2025-11-06 20:40:43 +00:00
Philip Abbey
5ab8229602 Update Numeric.md
Changed 'service' to 'action'. Careless omission for new documentation.

Signed-off-by: Philip Abbey <philipabbey@users.noreply.github.com>
2025-11-06 18:15:09 +00:00
Philip Abbey
8acc450c2c Update HISTORY.md
Amended v3.6 description.
2025-11-04 21:22:48 +00:00
Philip Abbey
1a52a942fd Added two screenshots for the Number Picker to Numeric.md (#316)
Amendment to documentation. Overlaps with changes a couple of changes on
#308 due to order.
2025-11-04 20:50:51 +00:00
Philip Abbey
d8b82f23e4 Merge branch 'main' into 315-add-screenshots-to-numericmd
Signed-off-by: Philip Abbey <philipabbey@users.noreply.github.com>
2025-11-04 20:50:24 +00:00
Philip Abbey
4943c87edb Icon script changes (#314)
A partial update that does not include managing the white variants of
the icons.
2025-11-04 20:49:22 +00:00
Philip Abbey
179c4d1bc5 Rename service to action (#308) 2025-11-04 20:48:58 +00:00
Joseph Abbey
6822cbe434 Allow floats for media_player picker limits 2025-11-04 19:09:45 +00:00
Joseph Abbey
fbeadf7ba9 Merge branch 'main' into rename-service-to-action 2025-11-04 19:02:19 +00:00
Joseph Abbey
b688cec8f6 Use minimum and maximum instead of const 2025-11-04 19:00:22 +00:00
Philip Abbey
4119665817 Added two screenshots for the Number Picker to Numeric.md 2025-11-02 23:15:59 +00:00
Philip Abbey
f0e263ae54 Update config.schema.json
Amended "Home Assistant Template" description.
2025-11-02 22:38:19 +00:00
Philip Abbey
abd6552916 Documentation changes
"Home Assistant" => "HomeAssistant" search & replace
Added schema change for "exit" feature.
Added initial Devices.md
2025-11-02 19:36:33 +00:00
Philip Abbey
60f754f3e3 Update HomeAssistantMenuItemFactory.mc
Reverting picker => data change, as I think the original was correct, compiled and functionally worked.
2025-11-02 17:41:21 +00:00
Joseph Abbey
bc5a7d04e4 Schema fixes and move "exit" into "tap_action" 2025-11-02 13:14:48 +00:00
Philip Abbey
643c4aa2e5 Icon script changes
A partial update that does not include managing the white variants of the icons,
2025-11-02 13:14:31 +00:00
Philip Abbey
8360a3e4a2 Documentation update
Mainly for the HTTP 410 error case.
2025-11-02 12:20:46 +00:00
22 changed files with 423 additions and 128 deletions

View File

@@ -2,7 +2,7 @@
# Background Service
The background service can report the following statuses from your device to your Home Assistant:
The background service can report the following statuses from your device to your HomeAssistant:
- Battery Level with charging status.
- Location and location accuracy.
@@ -12,13 +12,13 @@ If your device does not support the background service, the application will cle
## Limits
The values are merely samples of your device's current status. They are sent by a single background service at the repetition frequency you chose in the settings. The samples are sent at that one rate only, they _do not vary_ for example on in activity, on charge, time of day. You get one refresh interval and that is it. If you want to change the refresh interval, you change your settings. We do appreciate that may not be what you would ideally like to trigger actions on Home Assistant. Messing with the repeat interval of the background service requires more code, more settings and more complexity. That means older devices using widgets would have to be taken out of support to achieve it.
The values are merely samples of your device's current status. They are sent by a single background service at the repetition frequency you chose in the settings. The samples are sent at that one rate only, they _do not vary_ for example on in activity, on charge, time of day. You get one refresh interval and that is it. If you want to change the refresh interval, you change your settings. We do appreciate that may not be what you would ideally like to trigger actions on HomeAssistant. Messing with the repeat interval of the background service requires more code, more settings and more complexity. That means older devices using widgets would have to be taken out of support to achieve it.
**Please do not ask for these to be made 'events'.** Garmin's [Connect IQ background service](https://developer.garmin.com/connect-iq/api-docs/Toybox/System/ServiceDelegate.html) is limited in that while it does provide an `onActivityCompleted()` method, it does not provide an `onActivityStarted()` method, so you would not have the complete activity life cycle anyway. So we're keeping this implementation simple, you just get a sampling at one refresh rate. This probably limits you to updating a status on a Home Assistant Dashboard only.
**Please do not ask for these to be made 'events'.** Garmin's [Connect IQ background service](https://developer.garmin.com/connect-iq/api-docs/Toybox/System/ServiceDelegate.html) is limited in that while it does provide an `onActivityCompleted()` method, it does not provide an `onActivityStarted()` method, so you would not have the complete activity life cycle anyway. So we're keeping this implementation simple, you just get a sampling at one refresh rate. This probably limits you to updating a status on a HomeAssistant Dashboard only.
## Battery Reporting
From version 2.1 the application includes a background service to report the current device battery level and charging status back to Home Assistant. This is a feature that Garmin omitted to include with the Bluetooth connection.
From version 2.1 the application includes a background service to report the current device battery level and charging status back to HomeAssistant. This is a feature that Garmin omitted to include with the Bluetooth connection.
## Location Reporting
@@ -47,7 +47,7 @@ From version 2.6 the application includes reporting your activity. The activity
- Activity - This is an integer as defined by [Toybox.Activity `SPORT`](https://developer.garmin.com/connect-iq/api-docs/Toybox/Activity.html#Sport-module)
- Sub-activity - This is an integer as defined by [Toybox.Activity `SUB_SPORT`](https://developer.garmin.com/connect-iq/api-docs/Toybox/Activity.html#SubSport-module)
The application only provides the integers without translation. When using the values in Home Assistant, you will need to provide you own mapping from the `Activity` enumerated type to the human readable text. As developers of the application we are pushing this translation to the server to keep the Garmin application code 'lean'. You will also need to add to both the list of activities (sports) and sub-activities (sub-sports) an interpretation of integer `-1` for no activity/sub-activity at present.
The application only provides the integers without translation. When using the values in HomeAssistant, you will need to provide you own mapping from the `Activity` enumerated type to the human readable text. As developers of the application we are pushing this translation to the server to keep the Garmin application code 'lean'. You will also need to add to both the list of activities (sports) and sub-activities (sub-sports) an interpretation of integer `-1` for no activity/sub-activity at present.
## Start Reporting
@@ -55,7 +55,7 @@ The main drawback of this solution is that the Garmin application must be run on
It should be as simple as starting the application (or widget). There should be a new device in the mobile app integration called `Garmin Watch` with the battery level and charging status.
[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=mobile_app)
[![Open your HomeAssistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=mobile_app)
If this is not the case, head over to the [troubleshooting page](Troubleshooting.md#watch-battery-level-reporting).
@@ -67,7 +67,7 @@ To stop the reporting, the option must be turned off in the settings and then th
When the device is first created, it will be called `Garmin Watch`. This can be changed in the mobile app integration settings (button below).
[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=mobile_app)
[![Open your HomeAssistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=mobile_app)
Select the device called `Garmin Watch` and then click on the edit icon in the top right corner. You can then change the name of the device to whatever you like, then press `UPDATE` and then `RENAME`.
@@ -91,7 +91,7 @@ template:
icon: "mdi:battery{% if is_state('binary_sensor.<device>_battery_is_charging', 'on') %}-charging{% endif %}{% if 0 < (states('sensor.<device>_battery_level') | float / 10 ) | round(0) * 10 < 100 %}-{{ (states('sensor.<device>_battery_level') | float / 10 ) | round(0) * 10 }}{% else %}{% if (states('sensor.<device>_battery_level') | float / 10 ) | round(0) * 10 == 0 %}-outline{% else %}{% if is_state('binary_sensor.<device>_battery_is_charging', 'on') %}-100{% endif %}{% endif %}{% endif %}"
```
## Adding a sample Home Assistant UI widget
## Adding a sample HomeAssistant UI widget
A gauge for battery level with a charging icon making use of [mushroom cards](https://github.com/piitaya/lovelace-mushroom), [card_mod](https://github.com/thomasloven/lovelace-card-mod) and [stack-in-card](https://github.com/custom-cards/stack-in-card):
@@ -161,7 +161,7 @@ N.B. `sensor.<device>_battery_level` will likely need to be changed to `sensor.<
## Migrating
You should remove your old template sensors before migrating to the new integration. You can do this by removing the `sensor.<device>_battery_level` and `binary_sensor.<device>_battery_is_charging` entities from `configuration.yaml` and then restarting Home Assistant or reloading the YAML.
You should remove your old template sensors before migrating to the new integration. You can do this by removing the `sensor.<device>_battery_level` and `binary_sensor.<device>_battery_is_charging` entities from `configuration.yaml` and then restarting HomeAssistant or reloading the YAML.
[Here is the old configuration method for reference.](https://github.com/house-of-abbey/GarminHomeAssistant/blob/b51e2aa2a4afbc58ad466f3b81667d1cd252d091/BatteryReporting.md)

194
Devices.md Normal file
View File

@@ -0,0 +1,194 @@
# Device Support & Characterisation
A page just to note a practical limit on support for some older devices.
## Application Memory Usage
On an `instinct2x` device:
| Version | Free Memory (bytes) on `instinct2x`| Free Memory (bytes) on `venu2`|
|:-------:|-----------------------------------:|------------------------------:|
| 3.5 | 62,360 | - |
| 3.6 | 65,696 | 53,832 |
A user has reported a maximum of 26 items with Ver 3.5. This measurement has shown that each menu item requires about 1.0~1.2 kB. Using the worked example below it is possible to predict how many menu items your particular device might be able to support by using indicative figures.
## Worked Example
As a worked example, for Ver 3.6 working on an `instinct2x` device:
| Feature | Memory (bytes) | Cost (bytes) |
|--------------------------------------|---------------:|-------------:|
| Declared available to application | 98,304 | |
| Measured available to application | 94,112 | (4,192 less) |
| Application used | 65,696 | |
| Free before fetching menu definition | 28,416 | |
| Free after fetching menu definition | 15,792 | 12,624 |
| Free after construction | 936 | 14,856 |
Our test menu presently contains a mix of 28 items, consisting of nested group, toggle, tap, info and numeric items with templates. So each item requires (12,624 + 14,856) / 28 = 982 bytes.
## Garmin Devices
The following table details all the devices as at 1 October 2025 and whether they are supported by Garmin HomeAssistant. The available application memory is also detailed so that it can be compared to an application version listed above. Of particular concern are the 'Instinct' range of devices, being the smallest we currently support. New feature requests are now being vetted against how they might affect our ability to support the 'Instinct' range of devices. At some point support may have to be withdrawn in order to allow the Garmin HomeAssistant application to grow further.
| Device | Supported | Application Memory |
|----------------------------|:---------:|--------------------:|
| d2bravo | N | 65,536 |
| d2bravo_titanium | N | 65,536 |
| fenix3 | N | 65,536 |
| fenix3_hr | N | 65,536 |
| fr230 | N | 65,536 |
| fr235 | N | 65,536 |
| fr630 | N | 65,536 |
| fr920xt | N | 65,536 |
| vivoactive | N | 65,536 |
| descentg1 | Y | 98,304 |
| instinct2 | Y | 98,304 |
| instinct2s | Y | 98,304 |
| instinct2x | Y | 98,304 |
| instinctcrossover | Y | 98,304 |
| approachs60 | N | 131,072 |
| enduro | Y | 131,072 |
| fenix5 | Y | 131,072 |
| fenix5s | Y | 131,072 |
| fenix6 | Y | 131,072 |
| fenix6s | Y | 131,072 |
| fenixchronos | Y | 131,072 |
| fr245 | Y | 131,072 |
| fr55 | Y | 131,072 |
| fr645 | Y | 131,072 |
| fr735xt | N | 131,072 |
| fr935 | Y | 131,072 |
| instinct3solar45mm | Y | 131,072 |
| instincte40mm | Y | 131,072 |
| instincte45mm | Y | 131,072 |
| venusq | Y | 131,072 |
| vivoactive3 | Y | 131,072 |
| vivoactive3d | N | 131,072 |
| vivoactive_hr | N | 131,072 |
| edge_520 | N | 262,144 |
| fr255 | Y | 524,288 |
| fr255s | Y | 524,288 |
| approachs50 | Y | 786,432 |
| approachs7042mm | Y | 786,432 |
| approachs7047mm | Y | 786,432 |
| d2airx10 | Y | 786,432 |
| d2mach1 | Y | 786,432 |
| descentg2 | Y | 786,432 |
| descentmk343mm | Y | 786,432 |
| descentmk351mm | Y | 786,432 |
| enduro3 | Y | 786,432 |
| epix2 | Y | 786,432 |
| epix2pro42mm | Y | 786,432 |
| epix2pro47mm | Y | 786,432 |
| epix2pro47mmsystem7preview | Y | 786,432 |
| epix2pro51mm | Y | 786,432 |
| fenix7 | Y | 786,432 |
| fenix7pro | Y | 786,432 |
| fenix7pronowifi | Y | 786,432 |
| fenix7s | Y | 786,432 |
| fenix7spro | Y | 786,432 |
| fenix7x | Y | 786,432 |
| fenix7xpro | Y | 786,432 |
| fenix7xpronowifi | Y | 786,432 |
| fenix843mm | Y | 786,432 |
| fenix847mm | Y | 786,432 |
| fenix8pro47mm | Y | 786,432 |
| fenix8solar47mm | Y | 786,432 |
| fenix8solar51mm | Y | 786,432 |
| fenixe | Y | 786,432 |
| fr165 | Y | 786,432 |
| fr165m | Y | 786,432 |
| fr255m | Y | 786,432 |
| fr255sm | Y | 786,432 |
| fr265 | Y | 786,432 |
| fr265s | Y | 786,432 |
| fr57042mm | Y | 786,432 |
| fr57047mm | Y | 786,432 |
| fr955 | Y | 786,432 |
| fr965 | Y | 786,432 |
| fr970 | Y | 786,432 |
| instinct3amoled45mm | Y | 786,432 |
| instinct3amoled50mm | Y | 786,432 |
| instinctcrossoveramoled | Y | 786,432 |
| marq2 | Y | 786,432 |
| marq2aviator | Y | 786,432 |
| system8preview | N | 786,432 |
| venu2 | Y | 786,432 |
| venu2plus | Y | 786,432 |
| venu2s | Y | 786,432 |
| venu3 | Y | 786,432 |
| venu3s | Y | 786,432 |
| venu441mm | Y | 786,432 |
| venu445mm | Y | 786,432 |
| venusq2 | Y | 786,432 |
| venusq2m | Y | 786,432 |
| venux1 | Y | 786,432 |
| vivoactive5 | Y | 786,432 |
| vivoactive6 | Y | 786,432 |
| approachs62 | N | 1,048,576 |
| d2air | Y | 1,048,576 |
| edge1030 | Y | 1,048,576 |
| edge1030bontrager | Y | 1,048,576 |
| edge1030plus | Y | 1,048,576 |
| edge1040 | Y | 1,048,576 |
| edge1050 | Y | 1,048,576 |
| edge520plus | Y | 1,048,576 |
| edge530 | Y | 1,048,576 |
| edge540 | Y | 1,048,576 |
| edge550 | Y | 1,048,576 |
| edge820 | Y | 1,048,576 |
| edge830 | Y | 1,048,576 |
| edge840 | Y | 1,048,576 |
| edge850 | Y | 1,048,576 |
| edgeexplore | Y | 1,048,576 |
| edgeexplore2 | Y | 1,048,576 |
| edgemtb | Y | 1,048,576 |
| edge_1000 | N | 1,048,576 |
| epix | N | 1,048,576 |
| fr645m | Y | 1,048,576 |
| legacyherocaptainmarvel | Y | 1,048,576 |
| legacyherofirstavenger | Y | 1,048,576 |
| legacysagadarthvader | Y | 1,048,576 |
| legacysagarey | Y | 1,048,576 |
| venu | Y | 1,048,576 |
| venud | Y | 1,048,576 |
| venusqm | Y | 1,048,576 |
| vivoactive3m | Y | 1,048,576 |
| vivoactive3mlte | Y | 1,048,576 |
| vivoactive4 | Y | 1,048,576 |
| vivoactive4s | Y | 1,048,576 |
| d2charlie | N | 1,310,720 |
| d2delta | Y | 1,310,720 |
| d2deltapx | Y | 1,310,720 |
| d2deltas | Y | 1,310,720 |
| descentmk1 | N | 1,310,720 |
| descentmk2 | Y | 1,310,720 |
| descentmk2s | Y | 1,310,720 |
| fenix5plus | Y | 1,310,720 |
| fenix5splus | Y | 1,310,720 |
| fenix5x | Y | 1,310,720 |
| fenix5xplus | Y | 1,310,720 |
| fenix6pro | Y | 1,310,720 |
| fenix6spro | Y | 1,310,720 |
| fenix6xpro | Y | 1,310,720 |
| fr245m | Y | 1,310,720 |
| fr745 | Y | 1,310,720 |
| fr945 | Y | 1,310,720 |
| fr945lte | Y | 1,310,720 |
| marqadventurer | Y | 1,310,720 |
| marqathlete | Y | 1,310,720 |
| marqaviator | Y | 1,310,720 |
| marqcaptain | Y | 1,310,720 |
| marqcommander | Y | 1,310,720 |
| marqdriver | Y | 1,310,720 |
| marqexpedition | Y | 1,310,720 |
| marqgolfer | Y | 1,310,720 |
| gpsmap66 | Y | 2,359,296 |
| gpsmap67 | Y | 2,359,296 |
| gpsmap86 | N | 2,359,296 |
| gpsmaph1 | Y | 2,359,296 |
| montana7xx | Y | 2,359,296 |
| oregon7xx | N | 2,359,296 |
| rino7xx | N | 2,359,296 |

View File

@@ -51,4 +51,5 @@
| 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](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. Confirmations can now display a user supplied message. |
| 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. Confirmations can now display a user supplied message. [Schema update](README.md#old-deprecated-formats) to keep pace with HomeAssistant and correct a previous decision. Schema changes for consistency. |
| 3.7 | Bug fix for `numeric` menu items not working over Wi-Fi & LTE. |

View File

@@ -200,7 +200,14 @@ You can now specify alternative texts to use instead of "On" and "Off", e.g. "Lo
The [schema](https://raw.githubusercontent.com/house-of-abbey/GarminHomeAssistant/main/config.schema.json) is checked by using a URL directly back to this GitHub source repository, so you do not need to install that file. You can just copy & paste your entity names from the YAML configuration files used to configure HomeAssistant. With a submenu, there's a difference between `title` and `name`. The `name` goes on the menu item, and the `title` at the head of the submenu. If your dashboard definition fails to meet the schema, the application will simply drop items with the wrong field names without warning to protect itself.
### Old deprecated format
### Old Deprecated Formats
There are two reasons for the changes to the schema:
1. HomeAssistant made changes we feel we should track for consistency.
2. Retrospectively we decided there was a better way, just like HomeAssistant did. For these changes we apologise.
#### Service Field
Version 1.5 brought in a change to the JSON schema so the following old format remains useable but is no longer favoured.
@@ -245,6 +252,40 @@ The above should be replaced by the following:
This allows the `confirm` and `pin` fields to be accommodated in the `tap_action` along side the `action` tag, and follows the HomeAssistant YAML format more closely.
#### Exit Field
Version 2.31 added an "exit on tap" feature. In retrospect this field should have been nested inside the `tap_action` object.
> [!IMPORTANT] Deprecated:
```json
{
"entity": "automation.turn_off_stuff",
"name": "Turn off Stuff",
"type": "tap",
"tap_action": {
"action": "automation.trigger"
},
"exit": true
}
```
The above should be replaced by the following:
```json
{
"entity": "automation.turn_off_stuff",
"name": "Turn off Stuff",
"type": "tap",
"tap_action": {
"action": "automation.trigger",
"exit": true
},
}
```
A future move to v3.x will remove support for all deprecated JSON elements to simplify code. **Please ensure you track the schema changes in readiness.**
### More Examples
* [Switches](examples/Switches.md)
@@ -402,6 +443,8 @@ Check the latest unresolved [issues](https://github.com/house-of-abbey/GarminHom
9. When using Wi-Fi or LTE to toggle a light, the `toggle` will fail when the default or current state of the application's menu does not match the state of the light. The same applies to a cover or other thing that can be toggled. This is because the application is unable to initialise the menu with the current state without Bluetooth. Hence the Wi-Fi/LTE functionality is best used with `tap` items only.
10. There are memory limits, particularly for older devices. Please see the [explanation of the memory limits](Devices.md) and device support.
# Authors & Contributors
For an up to date list of all authors and contributors, please check the [contributor's page](https://github.com/house-of-abbey/GarminHomeAssistant/graphs/contributors). Thank you all for improving this application.

View File

@@ -315,9 +315,15 @@ JSON for copy & paste:
![No JSON](images/NoJson.png)
When the application persists in reporting "No JSON returned from HTTP request." this might be due to a mismatch between the Webhook ID and the device settings on the HomeAssistant server. We have discovered that the Webhook ID is required for HomeAssistant API calls with templates in order to work in a non-privileged account. The application options include the ability to clear the Webhook ID in the application forcing a new one to be set up. This should prevent the above error being shown on startup.
When the application persists in reporting _"No JSON returned from HTTP request"_ this might be due to a mismatch between the Webhook ID and the device settings on the HomeAssistant server. We have discovered that the Webhook ID is required for HomeAssistant API calls with templates in order to work in a non-privileged account. The application options include the ability to clear the Webhook ID in the application forcing a new one to be set up. This should prevent the above error being shown on startup.
Look for this option in the application settings:
![HTTP 410](images/http_410_error.jpg)
We now also have reports of an [HTTP 410](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/410) error occurring after an application update. With thanks to [@Aaroneisele55](https://github.com/Aaroneisele55) for resolving this issue also by the clearing of the Webhook ID. The cause of the problem remains unknown as updates do not generally require this correction between the Home Assistant server and the watch settings.
**Therefore, when the URL is known to work, any failure to return the JSON menu definition from an HTTPS request should try resetting the Webhook ID used with Home Assistant.**
To reset the Webhook ID look for this option in the application settings:
![Nabu Casa Setup](images/delete_webhook_id.png)

View File

@@ -47,7 +47,8 @@
"$ref": "#/$defs/enabled"
},
"exit": {
"$ref": "#/$defs/exit"
"$ref": "#/$defs/exit",
"deprecated": true
}
},
"required": [
@@ -58,6 +59,7 @@
"additionalProperties": false
},
"template": {
"deprecated": true,
"oneOf": [
{
"type": "object",
@@ -118,7 +120,8 @@
"$ref": "#/$defs/enabled"
},
"exit": {
"$ref": "#/$defs/exit"
"$ref": "#/$defs/exit",
"deprecated": true
}
},
"required": [
@@ -184,7 +187,8 @@
"$ref": "#/$defs/enabled"
},
"exit": {
"$ref": "#/$defs/exit"
"$ref": "#/$defs/exit",
"deprecated": true
}
},
"required": [
@@ -342,10 +346,12 @@
"const": "brightness"
},
"min": {
"const": 0
"type": "integer",
"minimum": 0
},
"max": {
"const": 255,
"type": "integer",
"max": 255,
"description": "Lights are not a percentage."
}
}
@@ -440,10 +446,12 @@
"const": "percentage"
},
"min": {
"const": 0
"type": "integer",
"minimum": 0
},
"max": {
"const": 100
"type": "integer",
"maximum": 100
}
}
}
@@ -475,10 +483,12 @@
"const": "position"
},
"min": {
"const": 0
"type": "integer",
"minimum": 0
},
"max": {
"const": 100
"type": "integer",
"maximum": 100
}
}
}
@@ -538,10 +548,12 @@
"const": "tilt_position"
},
"min": {
"const": 0
"type": "integer",
"minimum": 0
},
"max": {
"const": 100
"type": "integer",
"maximum": 100
}
}
}
@@ -565,10 +577,12 @@
"const": "position"
},
"min": {
"const": 0
"type": "integer",
"minimum": 0
},
"max": {
"const": 100
"type": "integer",
"maximum": 100
}
}
}
@@ -603,10 +617,13 @@
"const": "volume_level"
},
"min": {
"const": 0
"type": "number",
"minimum": 0
},
"max": {
"const": 1
"type": "number",
"maximum": 1,
"description": "Fraction [0,1], not percentage."
}
}
}
@@ -922,9 +939,51 @@
"title": "Home Assistant action name",
"pattern": "^[^.]+\\.[^.]+$"
},
"tap_action_tap": {
"allOf": [
{
"title": "Tap Action",
"description": "'confirm' and 'pin' fields are optional. 'action' is required.",
"properties": {
"service": {
"$ref": "#/$defs/action",
"deprecated": true
},
"action": {
"$ref": "#/$defs/action"
},
"data": {
"type": "object",
"title": "Your actions's parameters",
"description": "The object containing the parameters and their values to be passed to the entity. No schema checking can be done here, you are on your own! On application crash, remove the parameters."
}
},
"oneOf": [
{
"required": [
"action"
],
"not": {
"required": [
"service"
]
}
},
{
"required": [
"service"
]
}
]
},
{
"$ref": "#/$defs/tap_action"
}
]
},
"tap_action": {
"type": "object",
"title": "Action",
"title": "Tap Action",
"description": "'confirm' and 'pin' fields are optional.",
"properties": {
"confirm": {
@@ -932,45 +991,22 @@
},
"pin": {
"$ref": "#/$defs/pin"
},
"exit": {
"$ref": "#/$defs/exit"
}
}
},
"tap_action_tap": {
"$ref": "#/$defs/tap_action",
"properties": {
"service": {
"$ref": "#/$defs/action",
"deprecated": true
},
"action": {
"$ref": "#/$defs/action"
},
"data": {
"type": "object",
"title": "Your actions's parameters",
"description": "The object containing the parameters and their values to be passed to the entity. No schema checking can be done here, you are on your own! On application crash, remove the parameters."
},
"anyOf": [
{
"required": [
"service"
]
},
{
"required": [
"action"
]
}
]
}
},
"content": {
"title": "Home Assistant Template",
"description": "Jinja2 template defining the text to display. Must be included in an 'info'. Optional in a 'toggle', 'tap' and 'group'. Special characters may not render in the glance context.",
"description": "Jinja2 template defining the text to display. Must be included in an 'info'. Optional in a 'toggle', 'tap', 'numeric' and 'group'. Special characters may not render in the glance context.",
"type": "string"
},
"confirm": {
"type": ["boolean", "string"],
"type": [
"boolean",
"string"
],
"default": false,
"title": "Confirmation",
"description": "Optional confirmation of the action before execution as a precaution. Use a Boolean for the default message. Specify a string to display a specific confirmation message."

View File

@@ -95,9 +95,9 @@ You can choose individual items that will quit after they have completed their a
"name": "Turn off Stuff",
"type": "tap",
"tap_action": {
"action": "automation.trigger"
"action": "automation.trigger",
"exit": true
},
"exit": true
}
```

View File

@@ -75,6 +75,6 @@ The following shows the default glance when the menu file is not available at th
<img src="../images/Venu2_glance_no_menu.png" width="200" title="Venu 2 Glance showing errors"/>
Once the custom glance template has been retrieved and evaluated the display will change. Should the connectivity to your Home Assistant then be lost, e.g. you move out of range of your phone, the glance reflects this in the colour of the residual two rectangles. The top one remains an indicator for the API, and the bottom rectangle remains an indicator for the menu availability, reflecting the original placement in the default glance view that has now been replaced.
Once the custom glance template has been retrieved and evaluated the display will change. Should the connectivity to your HomeAssistant then be lost, e.g. you move out of range of your phone, the glance reflects this in the colour of the residual two rectangles. The top one remains an indicator for the API, and the bottom rectangle remains an indicator for the menu availability, reflecting the original placement in the default glance view that has now been replaced.
<img src="../images/Venu2_glance_no_bt.png" width="200" title="Venu 2 Glance showing lost connectivity"/>

View File

@@ -15,7 +15,7 @@ An example using a thermostat as a `numeric` menu item.
"type": "numeric",
"entity": "climate.room",
"tap_action": {
"service": "climate.set_temperature",
"action": "climate.set_temperature",
"picker": {
"step": 0.5,
"min": 10,
@@ -35,17 +35,17 @@ Field | Purpose
`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 |
`data_attribute` | The attribute on the `action` 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:
You might define a "helper" entity as follows in HomeAssistant:
<img src="../images/my_float.png" width="400" title="Home Assistant Helper definition for an 'input_number'." style="margin:5px"/>
<img src="../images/my_float.png" width="400" title="HomeAssistant Helper definition for an 'input_number'." style="margin:5px"/>
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.
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 `action` call that sets the chosen value from the number carousel.
```json
{
@@ -54,7 +54,7 @@ In this case, the state is the actual value, so the template uses `states(..)` i
"type": "numeric",
"entity": "input_number.my_float",
"tap_action": {
"service": "input_number.set_value",
"action": "input_number.set_value",
"picker": {
"step": 0.5,
"min": -10.0,
@@ -76,7 +76,7 @@ The complication here is this amplifier uses one scale for changing the value, a
"type": "numeric",
"entity": "media_player.amplifier",
"tap_action": {
"service": "media_player.volume_set",
"action": "media_player.volume_set",
"picker": {
"step": 0.005,
"min": 0.2,
@@ -88,31 +88,35 @@ The complication here is this amplifier uses one scale for changing the value, a
}
```
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.
<img src="../images/number_picker_raw.bmp" width="200" title="HomeAssistant Helper definition for an 'input_number'." style="margin:5px"/>
<img src="../images/template_number.png" width="500" title="Home Assistant Helper definition for an 'input_number'." style="margin:5px"/>
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 HomeAssistant as defined in the following dialogue box.
<img src="../images/template_number.png" width="500" title="HomeAssistant Helper definition for an 'input_number'." style="margin:5px"/>
For copy and paste, the Jinja2 fields are as follows:
1. Template rendering with conversion to dB:
```
```jinja
{{ state_attr('media_player.amplifier','volume_level') * 100 -80 }}
```
2. Conversion from dB to range 0.0 to 1.0:
```
```jinja
{{ (value+80)/100 }}
```
3. Availability template:
```
```jinja
{{ 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`:
<img src="../images/number_picker_db.bmp" width="200" title="HomeAssistant Helper definition for an 'input_number'." style="margin:5px"/>
As an alternative to using the GUI, the following can be pasted into HomeAssistant's `configuration.yaml`:
```yaml
template:
@@ -145,7 +149,7 @@ The JSON menu definition can now use dB with the new template number as follows.
"type": "numeric",
"entity": "number.amplifier_db",
"tap_action": {
"service": "number.set_value",
"action": "number.set_value",
"picker": {
"step": 0.5,
"min": -60.0,
@@ -160,4 +164,4 @@ The JSON menu definition can now use dB with the new template number as follows.
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.
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 HomeAssistant server.

View File

@@ -118,7 +118,9 @@ You can choose individual items that will quit after they have completed their a
"entity": "light.hall_light",
"name": "Hall Light & Quit",
"type": "toggle",
"exit": true
"tap_action" {
"exit": true
}
}
```

View File

@@ -44,15 +44,22 @@ Half = 2
# Original icons for 416x416 screen size with 48x48 icons
original = (96, 48, 24)
# The icons need to scale as a ratio of screen size 48:416 pixels
#
# Icon 55 53 48 46 42 37 32 30 28 26 24 21 19 18
# Screen 480 454 416 390 360 320 280 260 240 218 208 176 166 156
# Convert icons to different screen sizes by these parameters
lookup = {
# Doub Sing Half
# 0 1 2
480: (110, 55, 28),
454: (106, 53, 27),
# 416: ( 96, 48, 24),
390: ( 90, 46, 23),
360: ( 84, 42, 21),
320: ( 74, 38, 19),
295: ( 68, 34, 17), # Especially for the instinct3amoled50mm device that clip the icons
280: ( 64, 32, 16),
260: ( 60, 30, 15),
240: ( 56, 28, 14),

BIN
images/http_410_error.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

BIN
images/number_picker_db.bmp Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

View File

@@ -40,7 +40,7 @@ output_dir_prefix = 'resources-launcher-'
input_dir = output_dir_prefix + '70-70'
# Convert icons to different screen sizes by these parameters
lookup = [26, 30, 33, 35, 36, 40, 54, 60, 61, 62, 65, 80]
lookup = [26, 30, 33, 35, 36, 38, 40, 52, 54, 56, 60, 61, 62, 65, 68, 80]
# Delete all but the original 48x48 icon directories
for entry in os.listdir("."):

View File

@@ -143,7 +143,7 @@ fenix8solar51mm.resourcePath = $(fenix8solar51mm.resourcePath);resources-launche
fenixchronos.resourcePath = $(fenixchronos.resourcePath);resources-launcher-36-36;resources-icons-26
# Screen Size 416x416 launcher icon size 60x60
fenixe.resourcePath = $(fenixe.resourcePath);resources-launcher-60-60;resources-icons-48
# Screen Size 390 x 390 launcher icon size 54x54
# Screen Size 390x390 launcher icon size 54x54
fr165.resourcePath = $(descentmk2s.resourcePath);resources-launcher-54-54;resources-icons-46
fr165m.resourcePath = $(descentmk2s.resourcePath);resources-launcher-54-54;resources-icons-46
# Screen Size 240x240 launcher icon size 40x40

View File

@@ -155,8 +155,8 @@ class HomeAssistantMenuItemFactory {
label as Lang.String or Lang.Symbol,
entity_id as Lang.String?,
template as Lang.String?,
action as Lang.String?,
data as Lang.Dictionary?,
action as Lang.String?,
picker as Lang.Dictionary,
options as {
:exit as Lang.Boolean,
:confirm as Lang.Boolean,

View File

@@ -35,7 +35,7 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
//!
//! @param label Menu item label.
//! @param template Menu item template.
//! @param action Menu item action.
//! @param action Menu item action.
//! @param data Data to supply to the action call.
//! @param exit Should the action call complete and then exit?
//! @param confirm Should the action call be confirmed to avoid accidental invocation?
@@ -48,7 +48,7 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
function initialize(
label as Lang.String or Lang.Symbol,
template as Lang.String,
action as Lang.String?,
action as Lang.String?,
data as Lang.Dictionary?,
picker as Lang.Dictionary,
options as {
@@ -120,10 +120,10 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
WatchUi.pushView(
dialog,
new WifiLteExecutionConfirmDelegate({
:type => "action",
:type => "action",
:action => mAction,
:data => mData,
:exit => mExit,
:data => mData,
:exit => mExit,
}, dialog),
WatchUi.SLIDE_LEFT
);
@@ -154,27 +154,25 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
//! @param b Ignored. It is included in order to match the expected function prototype of the callback method.
//
function onConfirm(b as Lang.Boolean) as Void {
var dataAttribute = mPicker["data_attribute"];
if (dataAttribute == null) {
//return without call action if no data attribute is set to avoid crash
WatchUi.popView(WatchUi.SLIDE_RIGHT);
return;
}
var entity_id = mData["entity_id"];
if (entity_id == null) {
//return without call action if no entity_id is set to avoid crash
WatchUi.popView(WatchUi.SLIDE_RIGHT);
return;
}
mHomeAssistantService.call(
mAction,
{
"entity_id" => entity_id.toString(),
dataAttribute.toString() => mValue
},
mExit
);
var dataAttribute = mPicker["data_attribute"] as Lang.String?;
var entity_id = mData["entity_id"] as Lang.String?;
WatchUi.popView(WatchUi.SLIDE_RIGHT);
WatchUi.requestUpdate();
if (dataAttribute == null or entity_id == null) {
// Return without service call if no data attribute or entity ID is set to avoid crash.
return;
}
if (mAction != null) {
mHomeAssistantService.call(
mAction,
{
"entity_id" => entity_id.toString(),
dataAttribute.toString() => mValue
},
mExit
);
}
}
//! Return a numeric menu item's fetch state template.
@@ -182,8 +180,9 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
//! @return A string with the menu item's template definition (or null).
//
function getNumericTemplate() as Lang.String? {
var entity_id = mData["entity_id"];
var entity_id = mData["entity_id"] as Lang.String?;
var attribute = mPicker["attribute"] as Lang.String?;
if (entity_id == null) {
return null;
} else {

View File

@@ -121,7 +121,7 @@ class HomeAssistantService {
//! Invoke a action call for a menu item.
//!
//! @param action The Home Assistant action to be run, e.g. from the JSON `action` field.
//! @param data Data to be supplied to the action call.
//! @param data Data to be supplied to the action call.
//
function call(
action as Lang.String,
@@ -136,10 +136,10 @@ class HomeAssistantService {
WatchUi.pushView(
dialog,
new WifiLteExecutionConfirmDelegate({
:type => "action",
:type => "action",
:action => action,
:data => data,
:exit => exit,
:data => data,
:exit => exit,
}, dialog),
WatchUi.SLIDE_LEFT
);

View File

@@ -31,7 +31,7 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
//!
//! @param label Menu item label.
//! @param template Menu item template.
//! @param action Menu item action.
//! @param action Menu item action.
//! @param data Data to supply to the action call.
//! @param exit Should the action call complete and then exit?
//! @param confirm Should the action call be confirmed to avoid accidental invocation?
@@ -44,7 +44,7 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
function initialize(
label as Lang.String or Lang.Symbol,
template as Lang.String,
action as Lang.String?,
action as Lang.String?,
data as Lang.Dictionary?,
options as {
:alignment as WatchUi.MenuItem.Alignment,
@@ -83,10 +83,10 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
WatchUi.pushView(
pinConfirmationView,
new HomeAssistantPinConfirmationDelegate({
:callback => method(:onConfirm),
:pin => pin,
:state => false,
:view => pinConfirmationView,
:callback => method(:onConfirm),
:pin => pin,
:state => false,
:view => pinConfirmationView,
}),
WatchUi.SLIDE_IMMEDIATE
);

View File

@@ -47,7 +47,7 @@ class HomeAssistantView extends WatchUi.Menu2 {
var content = items[i].get("content") as Lang.String?;
var entity = items[i].get("entity") as Lang.String?;
var tap_action = items[i].get("tap_action") as Lang.Dictionary?;
var action = items[i].get("service") as Lang.String?; // Deprecated schema
var action = items[i].get("service") as Lang.String?; // Deprecated schema
var confirm = false as Lang.Boolean or Lang.String or Null;
var pin = false as Lang.Boolean?;
var data = null as Lang.Dictionary?;
@@ -57,7 +57,7 @@ class HomeAssistantView extends WatchUi.Menu2 {
enabled = items[i].get("enabled"); // Optional
}
if (items[i].get("exit") != null) {
exit = items[i].get("exit"); // Optional
exit = items[i].get("exit"); // Deprecated
}
if (tap_action != null) {
action = tap_action.get("service"); // Deprecated
@@ -71,6 +71,9 @@ class HomeAssistantView extends WatchUi.Menu2 {
if (tap_action.get("pin") != null) {
pin = tap_action.get("pin"); // Optional
}
if (tap_action.get("exit") != null) {
exit = tap_action.get("exit"); // Optional
}
}
if (type != null && name != null && enabled) {
if (type.equals("toggle") && entity != null) {

View File

@@ -24,12 +24,12 @@ using Toybox.Timer;
//
class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
public static var mCommandData as {
:type as Lang.String,
:type as Lang.String,
:action as Lang.String?,
:data as Lang.Dictionary?,
:url as Lang.String?,
:id as Lang.Number?,
:exit as Lang.Boolean
:data as Lang.Dictionary?,
:url as Lang.String?,
:id as Lang.Number?,
:exit as Lang.Boolean
}?;
private static var mTimer as Timer.Timer?;
@@ -52,7 +52,7 @@ class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
function initialize(
cOptions as {
:type as Lang.String,
:action as Lang.String?,
:action as Lang.String?,
:data as Lang.Dictionary?,
:url as Lang.String?,
:callback as Lang.Method?,
@@ -73,7 +73,7 @@ class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
mConfirmationView = view;
mCommandData = {
:type => cOptions[:type],
:action => cOptions[:action],
:action => cOptions[:action],
:data => cOptions[:data],
:url => cOptions[:url],
:callback => cOptions[:callback],