diff --git a/BatteryReporting.md b/BackgroundService.md similarity index 94% rename from BatteryReporting.md rename to BackgroundService.md index cdb6024..dd088e6 100644 --- a/BatteryReporting.md +++ b/BackgroundService.md @@ -1,5 +1,11 @@ [Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | Battery Reporting | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md) +The background service can report the following statuses from your watch to your Home Assistant: + +- Battery Level with charging status. +- Location and location accuracy. +- Activity information, but only if your watch supports API level 3.2.0. If your watch does not support this API level, this information is simply omitted. + # 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. diff --git a/HISTORY.md b/HISTORY.md index aaa9133..5acadbe 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) | [Battery Reporting](BatteryReporting.md) | [Trouble Shooting](TroubleShooting.md) | Version History +[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Background Service](BackgroundService.md) | [Trouble Shooting](TroubleShooting.md) | Version History # Version History @@ -13,8 +13,9 @@ | 1.6 | Added a user configurable 'timeout' in seconds so that when no action is taken the application automatically closes, stopping the continuous polling for changes of status and hence saving the drain on the battery. This can be disabled with timeout=0. | | 1.7 | Added timeout to confirmation views so that when used for security devices it does not linger when left unconfirmed. Thanks to [Jan Schneider](https://github.com/j-a-n) for the contribution. Known bug for devices not supporting [`WatchUi.getCurrentView()`](https://developer.garmin.com/connect-iq/api-docs/Toybox/WatchUi.html#getCurrentView-instance_function) API call which is only available on API Level 3.4.0, e.g. Vivoactive 4S. | | 2.0 | A significant code base change to enable both a 'widget' version for older devices, e.g. Venu (1), and an application with a glance, e.g. Venu2. These two versions must now be distributed under separate application IDs, but they have the same code base. A further 20 more devices are now supported, the settings have been internationalised, and there's a bug fix for older devices when trying to display a helpful error message but instead the application crashed. This version has come from a significant collaboration with [Someone0nEarth](https://github.com/Someone0nEarth). | -| 2.1 | Deployment of an idea to provide Home Assistant with access to the watch battery level. Using this requires [significant setup](BatteryReporting.md) on the Home Assistant configuration and hence is detailed separately. Due to this, the default state for this battery option is _off_. Changed the application settings user interface to be more intuitive, and hence amended the way settings are managed in the background. | +| 2.1 | Deployment of an idea to provide Home Assistant with access to the watch battery level. Using this requires [significant setup](BackgroundService.md) on the Home Assistant configuration and hence is detailed separately. Due to this, the default state for this battery option is _off_. Changed the application settings user interface to be more intuitive, and hence amended the way settings are managed in the background. | | 2.2 | Adds a feature to cache the menu configuration and save the time taken for an HTTP request to fetch it. You as the user are responsible for managing the cache by clearing it when you update your configuration. Improvement to widget root display updates. Bug fix for battery level reporting when in the glance carousel. Fixed an uninternationalised string, "Execute". Unfixed issue with battery level updates when the user is not an administrator. | | 2.3 | Fix for battery level updates where previously the function only worked for administrator accounts. The new solution is based on Webhooks and is simpler to implement on Home Assistant. Language support fix where an automatic translation produced an inappropriate word, possibly in more than one language. | | 2.4 | Sensor status reporting via Home Assistant 'templates'. This provides a generalised way of viewing the status of any entity as long as the result can be rendered as text, e.g. 'uncovered', 'open', '76%', '21 °C'. Removal of the menu style option. The original style was kept after the introduction of the icon style solely to keep the code for a possible re-use for sensor statuses. This version delivers that new feature, hence the style option has been removed. The new JSON configuration file format allows for the old style to be replicated if you are desperate! Added a feature to provide parameters to actions (`tap` or `template`). Added a feature to confirm `toggle` menu items. | | 2.5 | A small memory efficiency of about 1kB by removing `RezStrings.mc`. This will aid widgets on old watches that only have 60kB available to an application and are using about 45kB before the menu is fetched, hence 1kB is more significant to those devices. | +| 2.6 | Added more information reporting to the background service, in addition to the device battery level and charging status, we now include location, location accuracy, and (if supported by your device) the activity information. Note the updates are sent periodically and are not event driven. | \ No newline at end of file diff --git a/README.md b/README.md index acd578c..87c73ff 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Home | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Battery Reporting](BatteryReporting.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md) +Home | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Background Service](BackgroundService.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md) # GarminHomeAssistant diff --git a/TroubleShooting.md b/TroubleShooting.md index 964d4ae..abf1f43 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) | [Battery Reporting](BatteryReporting.md) | Trouble Shooting | [Version History](HISTORY.md) +[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Background Service](BackgroundService.md) | Trouble Shooting | [Version History](HISTORY.md) # Troubleshooting Guides diff --git a/examples/Actions.md b/examples/Actions.md index a6c08fc..68190db 100644 --- a/examples/Actions.md +++ b/examples/Actions.md @@ -1,4 +1,4 @@ -[Home](../README.md) | [Switches](Switches.md) | Actions | [Templates](Templates.md) | [Battery Reporting](../BatteryReporting.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) +[Home](../README.md) | [Switches](Switches.md) | Actions | [Templates](Templates.md) | [Background Service](../BackgroundService.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) # Actions diff --git a/examples/Switches.md b/examples/Switches.md index 1696b19..fe7e22a 100644 --- a/examples/Switches.md +++ b/examples/Switches.md @@ -1,4 +1,4 @@ -[Home](../README.md) | Switches | [Actions](Actions.md) | [Templates](Templates.md) | [Battery Reporting](../BatteryReporting.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) +[Home](../README.md) | Switches | [Actions](Actions.md) | [Templates](Templates.md) | [Background Service](../BackgroundService.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) # Switches diff --git a/examples/Templates.md b/examples/Templates.md index 481bea8..8c78fe2 100644 --- a/examples/Templates.md +++ b/examples/Templates.md @@ -1,4 +1,4 @@ -[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | Templates | [Battery Reporting](../BatteryReporting.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) +[Home](../README.md) | [Switches](Switches.md) | [Actions](Actions.md) | Templates | [Background Service](../BackgroundService.md) | [Trouble Shooting](../TroubleShooting.md) | [Version History](../HISTORY.md) # Templates diff --git a/images/GarminHomeAssistantSettings.png b/images/GarminHomeAssistantSettings.png index 2fbdf20..a8fb34c 100644 Binary files a/images/GarminHomeAssistantSettings.png and b/images/GarminHomeAssistantSettings.png differ diff --git a/resources/strings/strings.xml b/resources/strings/strings.xml index e696792..12ddf3c 100644 --- a/resources/strings/strings.xml +++ b/resources/strings/strings.xml @@ -45,21 +45,14 @@ URL for HomeAssistant API. URL for menu configuration (JSON). Should the application cache the menu configuration? - Should the application clear the existing cache next time it is - started? - Timeout in seconds. Exit the application after this period of - inactivity to save the device battery. - 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. + Should the application clear the existing cache next time it is started? + Timeout in seconds. Exit the application after this period of inactivity to save the device battery. + 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. Left (off) or Right (on) Menu Alignment. Left to right Right to Left - (Widget only) Automatically start the application from the widget - without waiting for a tap. - Enable the background service to send the clock battery - level to Home Assistant. - The refresh rate (in minutes) at which the background - service should repeat sending the battery level. - (Read only) The Webhook ID created by the watch for battery level updates. - You might require this for debugging. + (Widget only) Automatically start the application from the widget without waiting for a tap. + Enable the background service to send the device battery level, location and (if supported) activity data to Home Assistant. + The refresh rate (in minutes) at which the background service should repeat sending data. + (Read only) The Webhook ID created by the device for background service updates. You might require this for debugging.