Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ansible/templates] Enable ovos-PHAL-plugin-system plugin #217

Merged
merged 1 commit into from
Nov 29, 2024
Merged

[ansible/templates] Enable ovos-PHAL-plugin-system plugin #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ansible/roles/ovos_installer/templates/mycroft.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@
"max_msg_size": {{ 100 if ovos_installer_feature_gui | bool and ovos_installer_method == "containers" else 25 }}
},
"PHAL": {
{% if 'tas5806' in ovos_installer_i2c_devices %}
"admin": {
"ovos-PHAL-plugin-system": {
"enabled": true
}
}{% if 'tas5806' in ovos_installer_i2c_devices %},
Comment on lines +56 to +60
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Verify JSON structure and indentation.

The indentation of the closing brace at line 60 seems to be misaligned (3 spaces instead of 4), which could lead to invalid JSON generation.

Apply this fix:

    "admin": {
      "ovos-PHAL-plugin-system": {
        "enabled": true
      }
-   }{% if 'tas5806' in ovos_installer_i2c_devices %},
+    }{% if 'tas5806' in ovos_installer_i2c_devices %},
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"admin": {
"ovos-PHAL-plugin-system": {
"enabled": true
}
}{% if 'tas5806' in ovos_installer_i2c_devices %},
"admin": {
"ovos-PHAL-plugin-system": {
"enabled": true
}
}{% if 'tas5806' in ovos_installer_i2c_devices %},

💡 Codebase verification

The PHAL system plugin should indeed be conditional based on the profile

From the evidence found, the PHAL admin service is already conditionally enabled based on the profile (ovos_installer_profile != 'satellite' and ovos_installer_profile != 'server'). For consistency, the PHAL system plugin in mycroft.conf should follow the same conditional pattern since it's part of the same subsystem.

  • The plugin configuration in ansible/roles/ovos_installer/templates/mycroft.conf.j2 should be wrapped in a conditional check similar to its service configuration
  • The condition should match the systemd service pattern: {% if ovos_installer_profile != 'satellite' and ovos_installer_profile != 'server' %}
🔗 Analysis chain

Consider making the PHAL plugin conditionally enabled.

The ovos-PHAL-plugin-system is currently unconditionally enabled, while other PHAL configurations are conditional based on tas5806. Consider whether this plugin should also be conditional based on specific hardware or configuration requirements.

Let's check if this plugin has any dependencies on other configurations:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any related configuration or dependencies
rg -l "ovos-PHAL-plugin-system" --type yaml --type json

# Check if there are any related roles or tasks
fd -e yml -e yaml . ansible/roles/ovos_installer/tasks/ -x grep -l "ovos-PHAL-plugin-system" {} \;

Length of output: 157

Script:

#!/bin/bash
# Let's try a broader search for PHAL configurations and system plugin references
rg -i "phal.*plugin.*system" --type yaml --type json -A 5 -B 5

# Search for any system plugin installations or dependencies
rg -i "ovos.*phal.*system" 

# Check if there are any conditional patterns for PHAL plugins
rg "enabled.*true" ansible/roles/ovos_installer/templates/mycroft.conf.j2 -A 2 -B 2

Length of output: 1289

Script:

#!/bin/bash
# Let's check the profile-based conditions in the systemd configuration
rg -A 5 "ovos_installer_profile" ansible/roles/ovos_installer/defaults/main.yml

# Check for any PHAL-related variables or conditions
rg "ovos_installer_profile" ansible/roles/ovos_installer/templates/mycroft.conf.j2

# Look for any documentation about profiles
fd README -t f -X grep -i -A 5 -B 5 "profile"

Length of output: 595

"ovos-PHAL-plugin-hotkeys": {
"key_down": {
"mycroft.mic.listen": 582,
Expand Down