Merge pull request #440 from OpenVoiceOS/feat/ha-telemetry

[telemetry] Collect the information if HA is used or not

Author: goldyfruit

ansible/roles/ovos_telemetry/defaults/main.yml

@@ -1,5 +1,6 @@
 ---
 ovos_telemetry_feature_gui: "{{ ovos_installer_feature_gui | default(false) }}"
+ovos_telemetry_feature_homeassistant: "{{ ovos_installer_feature_homeassistant | default(false) }}"
 
 ovos_telemetry_geoip_url: http://ip-api.com/json
 ovos_telemetry_url: "https://telemetry.smartgic.io/ovos-installer/metrics/"

ansible/roles/ovos_telemetry/tasks/main.yml

@@ -54,6 +54,7 @@
                else (ovos_installer_raspberrypi | default('N/A')) }}
           skills_feature: "{{ ovos_installer_feature_skills | default(false) | bool }}"
           extra_skills_feature: "{{ ovos_installer_feature_extra_skills | default(false) | bool }}"
+          homeassistant_feature: "{{ ovos_telemetry_feature_homeassistant | default(false) | bool }}"
           gui_feature: "{{ ovos_telemetry_feature_gui | default(false) | bool }}"
           cpu_capable: "{{ ovos_installer_cpu_is_capable | default(false) | bool }}"
           tuning_enabled: "{{ (ovos_installer_tuning | default('no')) == 'yes' }}"

docs/telemetry.md

@@ -8,7 +8,7 @@ The data collection only happens during the installation process, nothing else w
 
 **The installer will ask you if you want to share or not the data.**
 
-Below is a list of the collected data _(please have a look to the [Ansible template](https://github.com/OpenVoiceOS/ovos-installer/blob/main/ansible/roles/ovos_telemetry/templates/telemetry.json.j2) used to publish the data)_.
+Below is a list of the collected data _(see the [Ansible task](https://github.com/OpenVoiceOS/ovos-installer/blob/main/ansible/roles/ovos_telemetry/tasks/main.yml) that builds and sends the telemetry payload)_.
 
 | Data                   | Description                                              |
 | ---------------------- | -------------------------------------------------------- |
@@ -21,6 +21,7 @@ Below is a list of the collected data _(please have a look to the [Ansible templ
 | `extra_skills_feature` | Extra OVOS's skills enabled during the installation      |
 | `gui_feature`          | GUI enabled during the installation                      |
 | `hardware`             | Is the device a Mark 1, Mark II or DevKit                |
+| `homeassistant_feature` | Home Assistant feature enabled during the installation    |
 | `installed_at`         | Date when OVOS has been installed                        |
 | `os_kernel`            | Kernel version of the host where OVOS is running         |
 | `os_name`              | OS name of the host where OVOS is running                |
@@ -33,3 +34,5 @@ Below is a list of the collected data _(please have a look to the [Ansible templ
 | `sound_server`         | What PulseAudio or PipeWire used                         |
 | `tuning_enabled`       | Did the Raspberry Pi tuning feature was used             |
 | `venv`                 | OVOS installed into a Python virtual environment         |
+
+No Home Assistant URL or API key values are collected, only whether the Home Assistant feature was enabled.