Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iteam1337/sonos-wejay
Slack integration for a local Sonos system
https://github.com/iteam1337/sonos-wejay
music reasonml slack sonos spotify
Last synced: about 2 hours ago
JSON representation
Slack integration for a local Sonos system
- Host: GitHub
- URL: https://github.com/iteam1337/sonos-wejay
- Owner: Iteam1337
- License: mit
- Created: 2018-10-07T17:16:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:37:37.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T11:04:24.457Z (7 months ago)
- Topics: music, reasonml, slack, sonos, spotify
- Language: Reason
- Homepage:
- Size: 4.77 MB
- Stars: 20
- Watchers: 7
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Sonos Wejay
[](https://github.com/Iteam1337/sonos-wejay/actions?workflow=Release)
Wejay is a music collaboration bot for Slack that can be used to add music to a local Sonos system. It needs to be started on the same network as your Sonos system in order to communicate with the speakers.
## Get started
### Prerequisites
Start by creating a `.env` file in the root directory of the project. This is for the Spotify search feature and to allow the bot to interact with Slack. It should contain
```
SPOTIFY_ID=spotify-token-here
SPOTIFY_SECRET=spotify-secret-here
SLACK_TOKEN=slack-token-here
WEJAY_IP=ip-of-the-speaker
```
Spotify token/secret can be generated by creating an app at https://developer.spotify.com/. Slack token can be found after adding the bot to your Slack below. The value for `WEJAY_IP` can be found in "About My Sonos System" of the Sonos Controller app, choose the IP of the speaker you'd like to send music to.
```
$ git clone https://github.com/Iteam1337/sonos-wejay.git
$ cd sonos-wejay
$ npm install
$ npm build && npm run dev
```
This will compile the Reason code and start up the Express app.
## Testing it out
1. The easiest way to start testing is using [ngrok](https://ngrok.com/). After you've installed `ngrok`, open another terminal and run `ngrok http 3000`. This will create a tunnel to you local environment.
2. Go to https://api.slack.com/apps and create a new app
3. Inside _OAuth & Permissions_ you'll find "Bot User OAuth Access Token" which is the token that should be added in your `.env` above.
4. Go to _Interactive Components_ and enable it. In the request url enter one of the urls provided by `ngrok` (http or https) and the route `/action`, i.e. https://127.0.0.1/action
5. Also on _Interactive Components_ add a action. Give it the name "Queue track" and description and callback id "queue"
6. Go to _Event Subscriptions_ and enable it. In the request url use the same url as above but use the route `/event`
7. Also on _Event Subscriptions_ add a "Bot User Event". The best one is `message.im`, which means you can send commands to the bot in private messages
8. You should be able to send some commands to the bot in Slack now, try sending `help` to see all available commands
## Available commands
| Command | Shorthand | Description |
| --------------------------------- | ------------------------ | ------------------------------------------------------------ |
| `blame` | | Who added the track? (requires MySQL database) |
| `clear` | | Reset playlist |
| `currentqueue` | `getqueue`, `gq`, `cq` | Display upcoming tracks |
| `fullqueue` | `fq` | Display all tracks currently in the queue |
| `help` | | Display the help text |
| `mute` | | Mute |
| `mostplayed` | | List the most played tracks (requires MySQL database) |
| `next` | `skip` | Skip one track forward |
| `nowplaying` | `np` | Display what's playing right now |
| `remove ` | `rm` | Remove tracks |
| `pause` | | Pause |
| `play` | | Play |
| `playtrack ` | | Play track number |
| `playlatest` | `pl` | Play latest track |
| `previous` | | Go back one track |
| `queue ` | `q ` | Queue a track using a Spotify URI |
| `search ` | `s ` | Search Spotify for a track |
| `toplist` | | List top Wejayers (requires MySQL database) |
| `unmute` | | Unmute |
| `volume <0-100>` | | Set volume, if no number is provided displays current volume |
### Copy and paste from Spotify
You can also select a couple of tracks in Spotify, press `cmd+c` (Mac) / `ctrl+c` (Windows), paste the copied information to the Wejay bot and send the message. Wejay will add all of your tracks at the end of the queue! :tada:
## Database
Some of the commands, like `blame` and `toplist` requires that you have a MySQL database that the service can access. We've included a `docker-compose.yml` that you can use to spin up a database.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
Rickard Laurin
💻 📖 🤔 👀
Tom Ekander
💻 🤔
Jimmy Jardland
💻 🤔
Nils Nilsson
💻 🤔
faroutchris
💻
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!