Helper library to develop Rhasspy apps in Python

Development
81

I will do it later. I want to have a second look at the Rhasspy source before that. Yesterday it confused me, as it seems to handle the dialogue continue session message always in the same way.

82

I have added your suggestions as issues in the repository. You can subscribe to an issue to follow progress.

83

It seems I got confused while testing. The issue with intentNotRecognized triggering a loop because it started to listen to it’s output is triggered by a 10 second TTS timeout in DialogueHermesMqtt.

My help text is pretty long (13 seconds). I thought I could also reproduce it with a shorter text but I can’t anymore. I have opened an issue: https://github.com/rhasspy/rhasspy/issues/62

85

I wrote a small countdown timer app using your library:

I think everything is there for that use case.

Some things that could help:

  • An easy way to access the slot values
  • An easy way to start a session (with type notitfication)
  • (in Rhasspy: a builtin slot type for duration)
86

That’s looking nice!

What would you suggest?

Yes, it makes sense to add a method to start a session.

Built-in slot types are indeed a feature that could help a lot of use cases. But that should be embedded in Rhasspy itself indeed. There have been some discussions about it already.

87

I’m now working on tests (current code coverage: 44%) and there’s autogenerated API documentation. I want to expand both before I create the first release on PyPI.

88

I just published the first release of Rhasspy Hermes App on PyPI: 0.1.0.

You can install it with:

pip3 install rhasspy-hermes-app

If the API of this library changes, your app possibly stops working when it updates to the newest release of Rhasspy Hermes App. Therefore, it’s best to define a specific version in your requirements.txt file:

rhasspy-hermes-app==0.1.0

This way your app keeps working when the Rhasspy Hermes App library adds incompatible changes in a new version.

I have expanded the documentation, including some information for people who want to contribute.

All contributions are welcome! New features, bug fixes, documentation, tests, …

@H3adcra5h I have added a lot of documentation, mypy annotations and tests to the code, but for now I have left your raw topic additions more or less alone because you know that part of the code better. If you could take a look at it, that would be awesome.

4 Likes
89

I am no real Python developer and don’t really know what is best practice for such things.

One idea would be: add a new parameter “supported_slots” to the decorator.

Could look like this:

@app.on_intent("StartTimer", supported_slots=["minutes", "seconds"])
def handle_start_timer(intent, minutes, seconds):
  or
def handle_start_timer(intent, slot_minutes, slot_seconds):

If the Intent has slot values for minutes or seconds handle_start_timer will get called with that otherwise it will provide “None”. One variant of this would be to also put the expected type into the decorator and let the decorator do the validation.

Another option: Just provide a helper function like mine in your module to get the slot values out of an intent. As you can see in my source (maybe I am doing it wrong) it is not that simple.

90

Ok, I have created an issue about easier access to slot values to welcome a discussion and follow progress on this.

91

I have released version 0.2.0 with two additions:

Added

  • Method HermesApp.notify to send a dialogue notification. See #10.
  • Decorator HermesApp.on_dialogue_intent_not_recognized to act when the dialogue manager failed to recognize an intent. See #9.

The latest version can be installed from PyPI:

pip3 install --upgrade rhasspy-hermes-app
1 Like
92

I have released version 1.0.0 now, with one big change:

Changed

  • All decorators of this library now only work with async functions. Pull request #16 by @JonahKr. Existing code should only add the async keyword before the function definition to keep the code valid. See Usage for some examples.

This is a breaking change, hence the major version bump. It has been contributed by @No_one and makes it easier to integrate Rhasspy apps with asynchronous APIs, improving performance. The latest version can be installed from PyPI.

4 Likes
93

Just a quick question. I don’t see any mqtt config in any of the examples on github. Am I correct in assuming that it just uses whatever config rhasspy itself uses?

94

No, it uses localhost:1883 as default, but you can change all MQTT connection settings as command-line options to your app. See the example output of python3 examples/time_app.py --help in the usage section of the documentation.

I’m still thinking about additional ways to pass these parameters, by the way.

95

Okay, if that is the case, I am definitely someone needing an additional way of setting things.

I am trying to get my complete chaos of weather app to be less of a chaos and have it use this as an optional output. Thing is, I am actually using a config ini to set parameters such as mqtt options (I am using paho mqtt directly right now and it will be an option even after adding support for this) so setting this with command line parameters would circumvent the config file that I need for quite a bit of other stuff.

It seems adding support for this needs to wait until there is a way to feed values from my config file into this app or I have given up on having mqtt settings in my config file.

96

There’s currently a pull request that adds support for something like this:

app = HermesApp("AdviceApp", host = "192.168.178.123", port = 12183)

This works with all parameters that are recognized on the command line. You could read your MQTT parameters from your configuration file and feed them like this into the app.

I still have to find some time to test it, especially how it interacts with parameters passed on the command line.

I’m cautious about adding direct support for a specific configuration format, because everyone has his own preferences for this, but the Rhasspy profile configuration format could be a sensible addition.

97

I would definitely prefer that format over the command line parameters, but I think I need to rethink a few things of my library because right now I don’t think my concept fits that well into yours. I need to play around with this a bit before I can figure that out.

It just occurred to me while writing this that reading mqtt settings out of a per library config is definitely not the way to go, so even the current way with command line parameters would work. My brain seems to be fried right now from coding to long and figuring out how to make my chaos less chaotic. Sorry for bothering you with this, I sometimes forget I write a library and not a standalone app.

98

Now I’m a bit confused: I thought you were talking about your weather app, but now you mention you’re writing a library.

99

I am talking about my weather app, my limited knowledge of python tells me that something that I can call and it does something is an app, if I need to call it from somewhere else and feed information into it is is a library. I might be wrong about that assumption, the python course at university definitely didn’t teach about things like that, only about what an if is and does.

Basically my weather something is supposed to be called by whatever whoever uses it wants to use, be that a script using rhasspy-hermes-app, a command script or something else. I just take whatever input, parse it with whatever the config tells me to use it as a parser and output to whatever the config tells me to output to. So if rhasspy-hermes-app is used the mqtt settings have to be done there, trying to fit my settings for “just output this to this mqtt server” in there is not the way to go.

100

Oh right, that way. Well, I’m curious, I’ll follow its development, because it looks like a very interesting app to have.

101

I have released version 1.1.0 , with one small but interesting change:

Changed

  • Command-line arguments can now also be passed as keyword arguments to the constructor of a HermesApp object. Note that arguments on the command line have precedence. Pull request #37 by @No_one with help from @maxbachmann.

Keep your issues, comments, pull requests coming. And feel free to let us know here how you use or want to use Rhasspy Hermes App or what can be improved.

1 Like