Having trouble installing my skill in ovos

whynine · September 8, 2023, 8:50pm

I have installed ovos with docker, as per https://openvoiceos.github.io/community-docs/install_ovos_docker/, on a Pi4 running 64 bit Raspbian Lite.

I have created a skills.list file containing:

ovos-skill-volume 
ovos-skill-fallback-unknown 
ovos-skill-stop 
ovos-skill-personal 
ovos-skill-naptime 
ovos-skill-date-time
ovos-skill-weather 
ovos-skill-hello-world 
git+https://github.com/WhyNine/tvheadend-radio-skill.git

I have also enabled debug in the mycroft.cong file.

I can see that my skill (and the others listed) installed as this was in the ovos_core log file:

Installing collected packages: TvheadendRadio, ovos-skill-hello-world, ovos-skill-fallback-unknown, tzlocal, numpy, future, decorator, timezonefinder, ratelim, geocoder, ovos-skill-volume, ovos-skill-weather, ovos-skill-stop, ovos-skill-personal, ovos-skill-naptime, ovos-skill-date-time
  DEPRECATION: TvheadendRadio is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559
  Running setup.py install for TvheadendRadio: started
  Running setup.py install for TvheadendRadio: finished with status 'done'
  DEPRECATION: future is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559
  Running setup.py install for future: started
  Running setup.py install for future: finished with status 'done'
Successfully installed TvheadendRadio-0.1 decorator-5.1.1 future-0.18.3 geocoder-1.38.1 numpy-1.25.2 ovos-skill-date-time-0.2.2 ovos-skill-fallback-unknown-0.0.3 ovos-skill-hello-world-0.0.3 ovos-skill-naptime-0.2.2 ovos-skill-personal-0.0.3 ovos-skill-stop-0.2.1 ovos-skill-volume-0.0.1 ovos-skill-weather-0.0.1a13 ratelim-0.1.6 timezonefinder-5.2.0 tzlocal-5.0.1

However when I launch ovos-cli and type “:skills”, my skill (tvheadend-radio-skill) is not included.

I had to create setup.py file in the tvheadend-radio-skill git to get it to install at all.

Why is my skill not being run, even though it installed?

mikejgray · September 8, 2023, 9:31pm

Hey @whynine,

Unfortunately you’ve run up against the one major piece of compatibility that OVOS did not maintain. Mycroft’s CommonPlay isn’t supported. It’s instead replaced by OCP, OVOS Common Play.

The documentation is in a time of transition but here’s a primer on how to write OCP skills. That should help with getting your skill in a state that will run in OVOS Docker containers:

github.com

OpenVoiceOS/community-docs/blob/d69c29274ddf7be3db8fc9efe3bad4fb6f884c02/docs/unused/dev_ocp_skill.md

# Developing OCP Skills

[OVOS Common Play (OCP)](glossary.md#ocp) is a full-fledged media player, compatible with the [MPRIS standard](glossary.md#mpris). Developing a skill for OCP is similar to writing any other OVOS-compatible skill except basic intents and playing media are handled for the developer. This documentation is a quick start guide for developers hoping to write an OCP skill.

## General Steps

- Create a skill class extending the OCP base class
- In the \_\_init\_\_ method indicate [the media types you want to handle](https://github.com/OpenVoiceOS/ovos-ocp-audio-plugin/blob/31701ded43a4f7ff6c02833d6aaf1bc0740257fc/ovos_plugin_common_play/ocp/status.py#L95)
- `self.voc_match(phrase, "skill_name")` to handle specific requests for your skill
- `self.remove_voc(phrase, "skill_name")` to remove matched phrases from the search request
- Implement the `ocp_search` decorator, as many as you want (they run in parallel)
  - The decorated method can return a list or be an iterator of `result_dict` (track or playlist)
  - The search function can be entirely inline or call another Python library, like [pandorinha](https://github.com/OpenJarbas/pandorinha) or [plexapi](https://github.com/pkkid/python-plexapi)
- `self.extend_timeout()` to not let OCP call for a Generic search too soon
  - Place one in each search function so it's extended every time the skill is called
- Implement a confidence score formula
  - [Values are between 0 and 100](https://github.com/OpenVoiceOS/ovos-ocp-audio-plugin/blob/31701ded43a4f7ff6c02833d6aaf1bc0740257fc/ovos_plugin_common_play/ocp/status.py#L4)
  - High confidence scores cancel other OCP skill searches
- `ocp_featured_media`, return a playlist for the OCP menu if selected from GUI
- Create a `requirements.txt` file with third-party package requirements

This file has been truncated. show original

Apologies for the inconvenience. Everything else should be fully backwards compatible!

goldyfruit · September 8, 2023, 9:55pm

@whynine o/

As a side note, the ovos-cli-client is not really maintained anymore, please have a look here: roadmap · Issue #14 · OpenVoiceOS/ovos-cli-client · GitHub

Its temporary replacement is mana, already part of the ovos_cli container.

But I think the issue seems related to the skill itself, I tried to install it and I don’t see it loading.

goldyfruit · September 8, 2023, 10:52pm

After updating briefly the skill to make it more compatible with OVOS, I was able to make it load (not working) and list it via ovos-cli-client.

2023-09-08 18:50:19.415 - skills - ovos_workshop.skill_launcher:_communicate_load_status:506 - INFO - Skill tvheadend_radio_skill.whynine loaded successfully

I sent a quick PR to allow you to see the changes made.

goldyfruit · September 9, 2023, 1:25am

Feel free to join the OpenVoiceOS - Docker channel for a more interactive help

whynine · September 9, 2023, 11:05am

Thanks for all the help. I naively assumed that there was compatibility between Mycroft and ovos skills

I will work on making it work with OCP

goldyfruit · September 9, 2023, 11:13am

A lot of them still compatible but OCP is a very special case.

ChanceNCounter · September 10, 2023, 2:38pm

We were committed to total backwards compatibility for a few years, but there came a point when it was just hamstringing us to save a handful of migrations a year.