# Neon Speech
Speech (Voice) Module for Neon Core. This module can be treated as a replacement for the
[mycroft-core](https://github.com/MycroftAI/mycroft-core) speech module. This module handles input audio, performs STT,
and optionally returns the text or forwards it to the skills module for intent parsing.
## Neon Enhancements
`neon-speech` extends `mycroft-speech` with the following added functionality:
* Support for continuous STT without a wake word
* Audio processing module plugin system to modify audio and extract context
* Messagebus API listeners to handle outside requests for STT or inputs to the skills module
* Arbitrary configuration supported by passing at module init
## Compatibility
Mycroft STT and Wake Word plugins are compatible with `neon-speech`, with the exception of skipping wake words,
which is currently only supported by Neon STT plugins.
## Running in Docker
The included `Dockerfile` may be used to build a docker container for the neon_speech module. The below command may be used
to start the container.
```shell
docker run -d \
--network=host \
--name=neon_speech \
-v ~/.config/pulse/cookie:/tmp/pulse_cookie:ro \
-v ${XDG_RUNTIME_DIR}/pulse:${XDG_RUNTIME_DIR}/pulse:ro \
--device=/dev/snd:/dev/snd \
-e PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native \
-e PULSE_COOKIE=/tmp/pulse_cookie \
neon_speech
```
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon_speech",
"name": "neon-speech",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/d6/a9/48f98558e9a90f40cb980ef5a9eb7a637c4fceb5ffffa9345da7a1d8d417/neon_speech-4.4.1.tar.gz",
"platform": null,
"description": "# Neon Speech\nSpeech (Voice) Module for Neon Core. This module can be treated as a replacement for the\n[mycroft-core](https://github.com/MycroftAI/mycroft-core) speech module. This module handles input audio, performs STT, \nand optionally returns the text or forwards it to the skills module for intent parsing.\n\n## Neon Enhancements\n`neon-speech` extends `mycroft-speech` with the following added functionality:\n* Support for continuous STT without a wake word\n* Audio processing module plugin system to modify audio and extract context\n* Messagebus API listeners to handle outside requests for STT or inputs to the skills module\n* Arbitrary configuration supported by passing at module init\n\n\n## Compatibility\nMycroft STT and Wake Word plugins are compatible with `neon-speech`, with the exception of skipping wake words,\nwhich is currently only supported by Neon STT plugins.\n\n## Running in Docker\nThe included `Dockerfile` may be used to build a docker container for the neon_speech module. The below command may be used\nto start the container.\n\n```shell\ndocker run -d \\\n--network=host \\\n--name=neon_speech \\\n-v ~/.config/pulse/cookie:/tmp/pulse_cookie:ro \\\n-v ${XDG_RUNTIME_DIR}/pulse:${XDG_RUNTIME_DIR}/pulse:ro \\\n--device=/dev/snd:/dev/snd \\\n-e PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native \\\n-e PULSE_COOKIE=/tmp/pulse_cookie \\\nneon_speech\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Neon Speech Module",
"version": "4.4.1",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon_speech"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a83dd50a21c207a3aefadd299f4690db1d0b8b7adc82d7e4f94e24314e663c48",
"md5": "46673c715d9132e070588c39dcbafd16",
"sha256": "4875ce732d87b07e94fcb23720d584ab7477cdd4e3576dcab0ee806de39d3179"
},
"downloads": -1,
"filename": "neon_speech-4.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46673c715d9132e070588c39dcbafd16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21082,
"upload_time": "2024-04-29T19:24:43",
"upload_time_iso_8601": "2024-04-29T19:24:43.865458Z",
"url": "https://files.pythonhosted.org/packages/a8/3d/d50a21c207a3aefadd299f4690db1d0b8b7adc82d7e4f94e24314e663c48/neon_speech-4.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6a948f98558e9a90f40cb980ef5a9eb7a637c4fceb5ffffa9345da7a1d8d417",
"md5": "40790cfe45ccacab3850504531bd650a",
"sha256": "756500f1c1893beb81a2ed344e34c5ac668ead6e161bbd9444516f3f646b4364"
},
"downloads": -1,
"filename": "neon_speech-4.4.1.tar.gz",
"has_sig": false,
"md5_digest": "40790cfe45ccacab3850504531bd650a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13674,
"upload_time": "2024-04-29T19:24:45",
"upload_time_iso_8601": "2024-04-29T19:24:45.886222Z",
"url": "https://files.pythonhosted.org/packages/d6/a9/48f98558e9a90f40cb980ef5a9eb7a637c4fceb5ffffa9345da7a1d8d417/neon_speech-4.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 19:24:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon_speech",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-speech"
}