# Neon Enclosure
The enclosure module implements the Platform and Hardware Abstraction Layer (PHAL)
from [OpenVoiceOS](https://github.com/OpenVoiceOS/ovos-PHAL). This service loads
PHAL plugins that provide different functionality to the core; plugins primarily
differ from skills in that they do not have any intents and that they may only
be valid in certain core environments (i.e. only for particular hardware or
operating system environments).
## Admin Services
`neon_enclosure.admin` contains a service much like `neon_enclosure`, but plugins
it loads will have `root` privileges. This service is intended for handling any
OS-level interactions requiring escalation of privileges and is excluded from Docker support.
Because this service runs as root, it also requires configuration be initialized
prior to its initialization; user-level configurations will be placed in the `/root`
directory per XDG, so any configuration should be done at the system-level.
## Running in Docker
The included `Dockerfile` may be used to build a docker container for the neon_audio module. The below command may be used
to start the container.
```shell
docker run -d \
--network=host \
--name=neon_enclosure \
-v ~/.config/pulse/cookie:/home/neon/.config/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=/home/neon/.config/pulse/cookie \
neon_enclosure
```
>*Note:* The above example assumes Docker data is stored in the standard user locations `~/.local/share` and `~/.config`.
> You may want to change these values to some other path to separate container and host system data.
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon-enclosure",
"name": "neon-enclosure",
"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/50/7a/2ebb251c205397ca86d2aadd7f0b5b11711c6655b07988fb920096cff0fd/neon-enclosure-1.7.0.tar.gz",
"platform": null,
"description": "# Neon Enclosure\nThe enclosure module implements the Platform and Hardware Abstraction Layer (PHAL)\nfrom [OpenVoiceOS](https://github.com/OpenVoiceOS/ovos-PHAL). This service loads\nPHAL plugins that provide different functionality to the core; plugins primarily \ndiffer from skills in that they do not have any intents and that they may only\nbe valid in certain core environments (i.e. only for particular hardware or\noperating system environments).\n\n## Admin Services\n`neon_enclosure.admin` contains a service much like `neon_enclosure`, but plugins\nit loads will have `root` privileges. This service is intended for handling any\nOS-level interactions requiring escalation of privileges and is excluded from Docker support.\nBecause this service runs as root, it also requires configuration be initialized\nprior to its initialization; user-level configurations will be placed in the `/root`\ndirectory per XDG, so any configuration should be done at the system-level.\n\n## Running in Docker\nThe included `Dockerfile` may be used to build a docker container for the neon_audio module. The below command may be used\nto start the container.\n\n```shell\ndocker run -d \\\n--network=host \\\n--name=neon_enclosure \\\n-v ~/.config/pulse/cookie:/home/neon/.config/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=/home/neon/.config/pulse/cookie \\\nneon_enclosure\n```\n\n>*Note:* The above example assumes Docker data is stored in the standard user locations `~/.local/share` and `~/.config`.\n> You may want to change these values to some other path to separate container and host system data.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Neon Enclosure Module",
"version": "1.7.0",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon-enclosure"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7470f3599a3a98ec5afad288595fbd1a7cab037d4766ada89b5b7e358134f7a6",
"md5": "a4d51a8e0d4530fcb6535a54881c4395",
"sha256": "49f2db197a86e91590f93a7490bb9aa8da0ca664c617bc916b45e3f474c051ea"
},
"downloads": -1,
"filename": "neon_enclosure-1.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4d51a8e0d4530fcb6535a54881c4395",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16066,
"upload_time": "2024-04-23T20:58:42",
"upload_time_iso_8601": "2024-04-23T20:58:42.349967Z",
"url": "https://files.pythonhosted.org/packages/74/70/f3599a3a98ec5afad288595fbd1a7cab037d4766ada89b5b7e358134f7a6/neon_enclosure-1.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "507a2ebb251c205397ca86d2aadd7f0b5b11711c6655b07988fb920096cff0fd",
"md5": "e25164d2ddab18bf2f5950d63bf1e7bf",
"sha256": "1da89740365c8fe02db970fc1fa11054ff70b14a619d54874a55b337e49e8e03"
},
"downloads": -1,
"filename": "neon-enclosure-1.7.0.tar.gz",
"has_sig": false,
"md5_digest": "e25164d2ddab18bf2f5950d63bf1e7bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7730,
"upload_time": "2024-04-23T20:58:44",
"upload_time_iso_8601": "2024-04-23T20:58:44.949720Z",
"url": "https://files.pythonhosted.org/packages/50/7a/2ebb251c205397ca86d2aadd7f0b5b11711c6655b07988fb920096cff0fd/neon-enclosure-1.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 20:58:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon-enclosure",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "neon-enclosure"
}
JSON
