Metadata-Version: 2.4
Name: oremi-device
Version: 1.0.0b4
Summary: Audio capture device for Oremi smart home ecosystem with wake word detection, speech transcription, and MQTT integration.
Project-URL: Say Thanks!, https://www.buymeacoffee.com/demsking
Project-URL: Source, https://gitlab.com/demsking/oremi-device
Project-URL: Tracker, https://gitlab.com/demsking/oremi-device/-/issues
Project-URL: Documentation, https://gitlab.com/demsking/oremi-device/-/blob/main/README.md
Author-email: Sébastien Demanou <demsking@gmail.com>
License: Apache-2.0
License-File: LICENSE
License-File: LICENSE_HEADER.txt
Keywords: detection,device,listener,mqtt,ohunerin,oremi,sound,wakeword
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Natural Language :: French
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.13,>=3.12
Requires-Dist: httpx>=0.28.1
Requires-Dist: paho-mqtt<3.0.0,>=2.1.0
Requires-Dist: pydantic-settings>=2.14.2
Requires-Dist: pydantic>=2.13.4
Requires-Dist: sounddevice<0.6.0,>=0.5.1
Requires-Dist: websockets<15.0,>=14.1
Description-Content-Type: text/markdown

# Oremi Device

[![Buy me a beer](https://img.shields.io/badge/Buy%20me-a%20beer-1f425f.svg)](https://www.buymeacoffee.com/demsking)

Oremi Device captures microphone audio and connects it to Oremi services:

- **Oremi Ohunerin** detects wake words and environmental sounds.
- **Oremi Andika** transcribes speech after Ohunerin detects a wake word.
- **Oremi Izwi** synthesizes spoken NLP responses when configured.
- **MQTT** exposes events, device controls, availability, and Home Assistant
  discovery entities.

The application monitors audio hardware while it runs. It can switch to another
compatible microphone when the active device disappears and switch back when a
preferred device becomes available again.

## Documentation

All project documentation—including architecture details, configuration
reference, and the Home Assistant integration guide—can be found at:
https://demsking.gitlab.io/oremi-device/

## Development

Oremi Device is built with Python and uses `uv` for dependency management. The
project follows standard Python development practices with type hints, linting,
and automated testing.

For detailed information on setting up your development environment, running
tests, code style guidelines, and the pull request process, please refer to
[CONTRIBUTING.md](https://gitlab.com/demsking/oremi-device/-/blob/main/CONTRIBUTING.md).

## Versioning

Oremi Device project adheres to [Semantic Versioning](https://semver.org/)
(SemVer). Version numbers follow the `MAJOR.MINOR.PATCH` format:

- **MAJOR** version increments for incompatible API changes
- **MINOR** version increments for backward-compatible new functionality
- **PATCH** version increments for backward-compatible bug fixes

The current version can be found by running:

```bash
docker run --rm demsking/oremi-device --version
oremi-device --version
```

## License

Licensed under the Apache License, Version 2.0. See [LICENSE](https://gitlab.com/demsking/oremi-device/-/blob/main/LICENSE).
