# phantom-remote-control
> HTTP Adapter to control Devialet Phantom Speakers (Play, Pause, Volume etc.)
Latest version **1.2.2** (published 2019-10-06) · GNU license · 0 weekly downloads
## Install
```sh
npm install phantom-remote-control
pnpm add phantom-remote-control
yarn add phantom-remote-control
bun add phantom-remote-control
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.2.2 |
| Published | 2019-10-06 |
| First published | 2019-10-04 |
| Weekly downloads | 0 |
| License | GNU |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 4 |
| Unpacked size | 54.2 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 16 |
| Maintainers | wandrille |
## Links
- npm: https://www.npmjs.com/package/phantom-remote-control
- Repository: https://github.com/VanVan/phantom-remote-control
- Homepage: https://github.com/VanVan/phantom-remote-control#readme
- Issues: https://github.com/VanVan/phantom-remote-control/issues
- npm.io page: https://npm.io/package/phantom-remote-control
## Dependencies (4)
- [request](https://npm.io/package/request.md) ^2.88.0
- [parseuri](https://npm.io/package/parseuri.md) 0.0.6
- [node-ssdp](https://npm.io/package/node-ssdp.md) ^4.0.0
- [upnp-mediarenderer-client](https://npm.io/package/upnp-mediarenderer-client.md) ^1.2.4
## Recent versions
- 1.2.2 (latest) — 2019-10-06
- 1.2.1 — 2019-10-06
- 1.1.2 — 2019-10-06
- 1.0.0 — 2019-10-06
- 0.1.0 — 2019-10-04
## README
[](https://www.npmjs.com/package/phantom-remote-control)
[](https://www.npmjs.com/package/phantom-remote-control)
[](https://github.com/VanVan/phantom-remote-control)
[](https://github.com/VanVan/ipfsProxyHTTP/blob/master/LICENSE)
Devialet phantom-remote-control
=======================
> HTTP Adapter to remote control Devialet Phantom Speakers
This code allows you to control your devialet phantom using a very simple API, or even from your web browser.
It automatically detects your Devialet Phantom speakers on your local network.
## 💡 Features
Control the musical playback of your Devialet speakers
| Devialet | 🔊 Phantom Dialog | 🔉 Phantom Premier |🔈 Phantom Reactor|
| -------------------------------------------- | :----------------: | :----------------: | :----------------:|
| Play mp3 file | ✔️ | ✔️ | ✔️ |
| Pause and Resume | ✔️ | ✔️ | ✔️ |
| Stop | ✔️ | ✔️ | ✔️ |
| Change volume | ✔️ | ✔️ | ✔️ |
| Get current volume | ✔️ | ✔️ | ✔️ |
| Increase or decrease volume | ✔️ | ✔️ | ✔️ |
| Recover the playback position | ✔️ | ✔️ | ✔️ |
| Recover the playback duration | ✔️ | ✔️ | ✔️ |
| Move playback to a specific time of the music| ✔️ | ✔️ | ✔️ |
| Control several speakers at the same time | ✔️ | ❌ | ✔️ |
## 🔧 [Installation](#install)
```
git clone https://github.com/VanVan/phantom-remote-control.git
cd phantom-remote-control
npm install
node index.js
```
You need [NodeJS](http://nodejs.org) and [NPM](https://www.npmjs.com/)
## ▶️ [Usage](#usage)
| URL | Description |
| -------------------------------- | ------------------------------------------- |
| `?play=http://site.com/music.mp3`| Play mp3 file |
| `?setVolume=30` | Set volume to a specific value |
| `?setVolume=Up` | Increase volume |
| `?setVolume=Down` | Decrease volume |
| `?pause=1` | Pause |
| `?play=1` | Resume |
| `?stop=1` | Stop |
| `?getPosition=1` | Get current position |
| `?getDuration=1` | Get music duration |
| `?seek=30` |Move playback to a specific time of the music|
🔗 Example:
```
http://127.0.0.1:8090/?setVolume=Up
```
> ⏩ These requests can be made by web browser or used as an API to serve as a keyboard shortcut for example.
## 🧰 Configuration
No configuration is needed, it works out of the box, however, you can edit config.json if you need to.
```
{
"http_local_port": 8090,
"devialet_ipaddress": "autodetect",
"devialet_port": "autodetect",
"devialet_device_description_xml": "autodetect",
"ssdp_detection_interval": 10000,
"volume_step": 10,
"debug": false
}
```
Each variable in the config can have these options:
* **http_local_port**: Local port to use to listen HTTP request.
* **devialet_ipaddress** and **devialet_port**: Can be used together to force this program to
use a specific or undetected sound system.
* **devialet_device_description_xml**: Can be used to force a specific device.
* **ssdp_detection_interval**: Interval to make SSDP request to find a device.
* **volume_step**: Up and Down volume step to use.
* **debug**: Let you use a .env file to specify environnement variable.
## ⌨ Using this program as a service
If you use it every day with your speakers, it would be better to configure it as a service on a Linux server or on your personal computer. By doing it, the program will always be running.
### Linux with systemd
You can simply install the service on Linux by entering the command
```
sudo node install_service.js
```
It will create a file `/etc/systemd/system/devialet.service`
You can then start the service by doing `sudo systemctl start devialet`
### Windows
You can simply install the service on Windows by entering the command
```
node install_service.js
```
To check if it works, just open `http://127.0.0.1:8090` on your browser
## ✏️ Contributing
- Add new control features
- Add a control panel to use in the browser
## 🎓 Copyright and license
Code released under the [GNU General Public License v3.0](https://github.com/VanVan/phantom-remote-control/blob/master/LICENSE).
---
_Source: https://npm.io/package/phantom-remote-control · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._