Skip to content
This repository has been archived by the owner on Jul 17, 2020. It is now read-only.

Commit

Permalink
updating documentation + update link to point to official doc
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyray committed Apr 19, 2019
1 parent 1f9a949 commit 21af5bd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions platforms/hermes-python/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,28 @@ You can disable/enable intents with the following methods :
hermes.configure_dialogue(dialogue_conf)


Configuring Sound Feedback
==========================

By default, the snips platform notify the user of different events of
its lifecycle with sound. It emits a sound when the wakeword is
detected, or when the NLU engine (natural understanding engine) has
successfuly extracted an intent from a spoken sentence.

``hermes-python`` allows to disable this sound feedback
programmatically, by sending a message to the snips platform,
specifying the ``siteId`` where the sound feedback should be disabled.

::

from hermes_python.hermes import Hermes
from hermes_python.ontology.feedback import SiteMessage

with Hermes("localhost:1883") as h:
h.disable_sound_feedback(SiteMessage("kitchen"))
h.start()


Enabling Debugging
==================

Expand Down
2 changes: 1 addition & 1 deletion platforms/hermes-python/hermes_python/__version__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__title__ = 'hermes_python'
__version__ = '0.5.0'
__description__ = 'Python bindings for Snips Hermes Protocol'

__url__ = 'https://hermespython.readthedocs.io/en/latest/'
2 changes: 1 addition & 1 deletion platforms/hermes-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def get_tag(self):
long_description=readme + history,
author='Anthony Reinette',
author_email='[email protected]',
url='https://github.com/snipsco/hermes-protocol/tree/develop/platforms/hermes-python',
url=about['__url__'],
classifiers=[
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
Expand Down

0 comments on commit 21af5bd

Please sign in to comment.