Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mcollovati/vaadin-annyang

Voice commands for Vaadin
https://github.com/mcollovati/vaadin-annyang

annyang speechkit vaadin

Last synced: 15 days ago
JSON representation

Voice commands for Vaadin

Awesome Lists containing this project

README 

        
# V-Annyang



Voice commands for Vaadin.

 

V-Annyang lets you trigger your server side commands using your voice; 

simply extend UI and register the commands you need.

   

```java

class MyUI extends UI {



    protected void init(VaadinRequest request) {

        // other java code

        //...   

        

        Annyang.of(this)

            .addCommand("test", params -> Notification.show("You called test command"))

            .addCommand("hide :component", params -> componentsMap.get(params[0]).setVisible(false))

            .addCallback((AnnyangEvents.PermissionBlockedListener) this::showPermissionBlockedNotification)

            .addStatusChangeListener(event -> {

                if (event.getNewStatus() == AnnyangStatus.UNSUPPORTED) {

                    unsupportedFeature();

                }

            }).start();

        // other java code

        //...   

   }

}

```



The addon is based on [annyang!](https://www.talater.com/annyang/), a tiny javascript library for SpeechRecognition

and command invocation; the Vaadin component lets you easily attach server side code to the client side command invocation.



For more information about command syntax see **annyang!** 

[Command Object](https://github.com/TalAter/annyang/blob/master/docs/README.md#commands-object) page. 



The addons is written for Java 8 and was tested only on google chrome.



### SpeechKITT integration



The addon come with built-in support for [SpeechKITT](https://github.com/TalAter/SpeechKITT), 

a flexible GUI for interacting with Speech Recognition.



```java

class MyUI extends UI {



    protected void init(VaadinRequest request) {

        // other java code

        //...   

        

        Annyang annyang = Annyang.of(this);

        

        //....

        

        SpeechKITT speechKITT = annyang.withSpeechKitt()

            .withSampleCommands("test", "search")

            .withFlatTheme(SpeechKITT.FlatTheme.ORANGE)

            .withInstructionsText("Try some voice commands");



    }

```



## Online demo



TODO

Try the add-on demo at 



## Download release



TODO



## Building and running demo



```

git clone https://github.com/mcollovati/vaadin-annyang.git

mvn clean install

cd demo

mvn jetty:run

```



To see the demo, navigate to http://localhost:8080/

 

## Release notes



### Version 1.0-SNAPSHOT

- TODO



## Roadmap



This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases. 

That said, the following features are planned for upcoming releases:



- TODO 



## Issue tracking



The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated. 



## Contributions



Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

- Fork this project

- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.

- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.

- Refer to the fixed issue in commit

- Send a pull request for the original project

- Comment on the original issue that you have implemented a fix for it



## License & Author



Add-on is distributed under Apache License 2.0. For license terms, see [LICENSE.txt](LICENSE.txt).



[annyang!](https://www.talater.com/annyang/) and [Speech KITT](https://github.com/TalAter/SpeechKITT) 

 are release under [MIT](http://opensource.org/licenses/MIT) license.



# Developer Guide



## Getting started



Here is a simple example on how to try out the add-on component:



```java

        Annyang.of(ui)  // extend UI

            // add commands

            .addCommand("test", params -> Notification.show("You called test command"))

            .addCommand("hide :component", params -> componentsMap.get(params[0]).setVisible(false))

            // add callbacks for various events: unsupported, start, end, error, ...

            .addCallback((AnnyangEvents.StartListener) this::onStart)

            // and finally start speech recognition

            .start()

```



For a more comprehensive example, see src/test/java/org/vaadin/addon/annyang/demo/DemoUI.java 

in the demo sub module.



## API



V-Annyang JavaDoc is available online at <...>