Metadata-Version: 2.1
Name: neon-enclosure
Version: 0.1.2
Summary: Neon Enclosure Module
Home-page: https://github.com/NeonGeckoCom/neon-enclosure
Author: Neongecko
Author-email: developers@neon.ai
License: NeonAI License v1.0
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: mycroft-messagebus-client (>=0.9)
Requires-Dist: neon-utils (>=0.5.7)
Requires-Dist: tornado (==6.0.3)
Requires-Dist: RPi.GPIO (==0.7.0)
Requires-Dist: smbus2 (==0.4.0)
Requires-Dist: pulsectl (~=21.5)
Requires-Dist: pulse

# Neon Enclosure
Enclosure module to handle any core interactions with hardware, including volume controls,
lights, buttons, etc.

## 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 ${NEON_DATA_DIR}:/home/neon/.local/share/neon:rw \
-v ${NEON_CONFIG_DIR}:/home/neon/.config/neon:rw \
-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.


