Walter vl: Added Python plugins

2022-02-21T15:23:16Z

Added Python plugins

New page

==Introduction==
A native integration of the Sonos wireless music system in Domoticz is something that I think would be highly appreciated by a lot of Domoticz users. Unfortunately until now there is no hardware support included by default. User m_g_s_g started to work on [https://www.domoticz.com/forum/viewtopic.php?f=28&t=3721 a native Sonos plugin] for a while but unfortunately he abandoned the project. The code is still [https://github.com/mgsg/domoticz-sonos-plugin on GitHub] waiting for someone to pick this up and continue his work.

Next to the native plugin there are multiple other solutions available by using scripts. Below the ones that can be found on the forum:

*Easy Sonos
*Node Sonos HTTP API
*Wrapper for PHPSonos
*Sonos Soco Plugin

==Easy Sonos==
The instructions below are based on [https://www.domoticz.com/forum/viewtopic.php?f=38&t=6088 this topic] thanks to Marmo

*Download from https://www.github.com/DjMomo/sonos the file sonos.class.php and copy it to your scripts directory
*Install PHP and PHP5 curl if it is not installed on your machine. So sudo apt-get install php5-cli php5-curl (in Debian).
*To do an easy test, create two separate scripts for PLAY (sonos.play.php) and PAUSE (sonos.pause.php), both similar except in the command itself. As follows (only change the IP address to the IP of your Sonos):

<pre>
#!/usr/bin/env php
<?php
$IP_sonos_1 = "192.168.1.20";
require("sonos.class.php");
$sonos_1 = new SonosPHPController($IP_sonos_1);
$sonos_1 = $sonos_1->Play();
?>
</pre>

*chmod u+x the created play and pause files
*Call them from a virtual switch like this: script:///path to domoticz dir/domoticz/scripts/sonos.play.php

==Wrapper for PHPSonos==
This works similar to the Easy Sonos solution. The only difference is that you need to have a PHP enabled webserver in order to have this working. User G3rard forked the [https://github.com/ThomasTr/sonos original wrapper] by ThomasTr and improved it a bit for use with Domoticz. This also includes text to speach functionality.

To install this follow the instructions as [https://github.com/gerard33/sonos described here].

==Node Sonos HTTP API==

Another solution is to use the [https://github.com/jishi/node-sonos-http-api Node Sonos HTTP API]. There is a nice step-by-step guide on the forum made by Holland, it is a bit more extensive than the instructions below, you can find it [https://www.domoticz.com/forum/viewtopic.php?f=38&t=10940 here]

*If you don't use the Domoticz SD card image first install node.js from the [[MQTT#Installing Node.JS|instructions from the link in point 1 here]].
*log into your machine through a shell and go to the home directory (normally one directory higher than the domoticz directory)
*<code>git clone https://github.com/jishi/node-sonos-http-api node-sonos-http-api</code>
*<code>cd node-sonos-http-api</code>
*<code>npm install --production</code>
*start the server by running <code>npm start</code>
*Now you can control your system by invoking the following commands:

<pre>
http://localhost:5005/zones
http://localhost:5005/lockvolumes
http://localhost:5005/unlockvolumes
http://localhost:5005/pauseall[/{timeout in minutes}]
http://localhost:5005/resumeall[/{timeout in minutes}]
http://localhost:5005/preset/{JSON preset}
http://localhost:5005/preset/{predefined preset name}
http://localhost:5005/{room name}/{action}[/{parameter}]
http://localhost:5005/reindex
http://localhost:5005/sleep/{timeout in seconds or timestamp HH:MM:SS or off}
</pre>
More info can be found [https://github.com/jishi/node-sonos-http-api here]

==Sonos Soco Python Module==
The [https://github.com/SoCo/SoCo Soco] is based on Python and therefore requires Python 2.7, or 3.2 or newer. (I have not installed this myself so below is just an educational guess)

*Log into your machine through a shell and go to the home directory (normally one directory higher than the domoticz directory)
*Install python and python-pip package and/or python3 and python3-pip
*<code>git clone https://github.com/SoCo/SoCo SoCo</code>
*<code>cd SoCo</code>
*<code>sudo pip install soco</code>
*<code>sudo pip3 install soco</code>

More info on SoCo [https://github.com/SoCo/SoCo here].

== Python Plugins ==
There are some Python plugins created on github but all not recently updated.

https://github.com/gerard33/sonos

https://github.com/Gerard-Oedzes/domoticz-sonos

==Forum topics for reference==

*[https://www.domoticz.com/forum/viewtopic.php?f=28&t=3721 Sonos Native Plugin]
*[https://www.domoticz.com/forum/viewtopic.php?f=38&t=6088 Easy Sonos]
*[https://www.domoticz.com/forum/viewtopic.php?f=38&t=8953 Updated Sonos TTS (PHP)]
*[https://www.domoticz.com/forum/viewtopic.php?f=28&t=5289 Sonos Soco Plugin]
*[https://www.domoticz.com/forum/viewtopic.php?f=38&t=10940 Node Sonos http-api step-by-step guide]

Sonos - Revision history

Walter vl: Added Python plugins