https://github.com/definitio/ha-sox

A Home Assistant integration to turn your vacuum into an audio player.
https://github.com/definitio/ha-sox

audio-player home-assistant integration roborock robot-vacuum smarthome vacuum xiaomi

Last synced: about 2 months ago
JSON representation

A Home Assistant integration to turn your vacuum into an audio player.

• Host: GitHub
• URL: https://github.com/definitio/ha-sox
• Owner: definitio
• License: mit
• Created: 2020-07-28T14:51:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-03T16:11:18.000Z (over 1 year ago)
• Last Synced: 2025-03-03T17:22:19.922Z (over 1 year ago)
• Topics: audio-player, home-assistant, integration, roborock, robot-vacuum, smarthome, vacuum, xiaomi
• Language: Python
• Homepage:
• Size: 29.3 KB
• Stars: 24
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SoX component for Home Assistant

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)

A Home Assistant integration to turn your vacuum into an audio player.

## Installation

- Install firmware for your Xiaomi (Roborock) vacuum - use [pre-build firmware](https://github.com/zvldz/vacuum#already-build-firmware) or [build it yourself](https://github.com/zvldz/vacuum) with `--enable-sound-server` option.

- Install the integration to Home Assistant: use [HACS](https://hacs.xyz/) or copy the contents of `custom_components/sox/` to `/custom_components/sox/`.

## Configuration

- Add the following lines to your Home Assistant's `configuration.yaml` file:

```yaml

media_player:

  - platform: sox

    name: sox

    host: 

    port: 7777

```

- Restart Home Assistant

### Configuration Options

- **name:** _(string) (Optional)_

  This is the name you would like to give to SoX media player.

  _Default value: `sox`_

- **host:** _(string) (Required)_

  This is the hostname, domain name or IP address of your vacuum.

- **port:** _(string) (Optional)_

  This is the port that the SoX player on your vacuum can be reached at.

  _Default value: `7777`_

## Useful links

- [Media Player documentation](https://www.home-assistant.io/integrations/media_player)

- [Home Assistant forum](https://community.home-assistant.io)