/**
* constructor
*
* @throws Exception if $type is not valid
* @access public
*/
public function __construct($parentId, $name, $content, $debug = false)
{
$this->parentId = $parentId;
$this->name = $name;
$this->content = $content;
$this->debug = $debug;
$this->id = @IPS_GetScriptIDByName($this->name, $this->parentId);
//check if event does already exist
if ($this->id == false) {
if ($this->debug) {
echo "INFO - create IPS script {$name}\n";
}
$this->id = IPS_CreateScript(0);
IPS_SetName($this->id, $this->name);
IPS_SetParent($this->id, $this->parentId);
IPS_SetScriptContent($this->id, $this->content);
IPS_SetInfo($this->id, "this script was created by script " . $_IPS['SELF'] . " which is part of the ips-library (https://github.com/florianprobst/ips-library)");
}
}
public function ApplyChanges()
{
// Diese Zeile nicht löschen
parent::ApplyChanges();
if (strlen($this->ReadPropertyString("API")) == 16) {
//Instanz ist aktiv
$this->SetStatus(102);
//Script + Timer
$UpdateInterval = $this->ReadPropertyInteger("UpdateInterval");
IPS_LogMessage($_IPS['SELF'], "Update Interval " . $UpdateInterval . " Minuten");
$UpdateWeatherScriptID = @$this->GetIDForIdent("_updateWeather");
if ($UpdateWeatherScriptID === false) {
$UpdateWeatherScriptID = $this->RegisterScript("_updateWeather", "_updateWeather", file_get_contents(__DIR__ . "/_updateWeather.php"), 99);
} else {
IPS_SetScriptContent($UpdateWeatherScriptID, file_get_contents(__DIR__ . "/_updateWeather.php"));
}
IPS_SetHidden($UpdateWeatherScriptID, true);
IPS_SetScriptTimer($UpdateWeatherScriptID, $UpdateInterval);
} else {
//Instanz ist inaktiv
$this->SetStatus(104);
}
}
function GetOrCreateScript($parent, $ident)
{
$ObjId = @IPS_GetObjectIDByIdent($ident, $parent);
if ($ObjId === false) {
$ObjId = IPS_CreateScript(0);
IPS_SetParent($ObjId, $parent);
IPS_SetIdent($ObjId, $ident);
IPS_SetName($ObjId, $ident);
IPS_SetScriptContent($ObjId, ScriptContent($ident));
}
return $ObjId;
}
public function ApplyChanges()
{
$ipAddress = $this->ReadPropertyString("IPAddress");
if ($ipAddress) {
$curl = curl_init();
curl_setopt_array($curl, array(CURLOPT_RETURNTRANSFER => 1, CURLOPT_URL => 'http://' . $ipAddress . ':1400/xml/device_description.xml'));
$result = curl_exec($curl);
if (!curl_exec($curl)) {
die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
}
}
//Never delete this line!
parent::ApplyChanges();
// Start create profiles
$this->RegisterProfileIntegerEx("Status.SONOS", "Information", "", "", array(array(0, "Prev", "", -1), array(1, "Play", "", -1), array(2, "Pause", "", -1), array(3, "Stop", "", -1), array(4, "Next", "", -1), array(5, "Transition", "", -1)));
$this->RegisterProfileInteger("Volume.SONOS", "Intensity", "", " %", 0, 100, 1);
$this->RegisterProfileInteger("Tone.SONOS", "Intensity", "", " %", -10, 10, 1);
$this->RegisterProfileInteger("Balance.SONOS", "Intensity", "", " %", -100, 100, 1);
$this->RegisterProfileIntegerEx("Switch.SONOS", "Information", "", "", array(array(0, "Off", "", 0xff0000), array(1, "On", "", 0xff00)));
//Build Radio Station Associations according to user settings
if (!IPS_VariableProfileExists("Radio.SONOS")) {
$this->UpdateRadioStations();
}
// Build Group Associations according Sonos Instance settings
$allSonosInstances = IPS_GetInstanceListByModuleID("{F6F3A773-F685-4FD2-805E-83FD99407EE8}");
$GroupAssociations = array(array(0, "none", "", -1));
foreach ($allSonosInstances as $key => $SonosID) {
if (@IPS_GetProperty($SonosID, "GroupCoordinator")) {
$GroupAssociations[] = array($SonosID, IPS_GetName($SonosID), "", -1);
}
}
if (IPS_VariableProfileExists("Groups.SONOS")) {
IPS_DeleteVariableProfile("Groups.SONOS");
}
$this->RegisterProfileIntegerEx("Groups.SONOS", "Network", "", "", $GroupAssociations);
// End Create Profiles
// Start Register variables and Actions
// 1) general availabe
$this->RegisterVariableString("nowPlaying", "nowPlaying", "", 20);
$this->RegisterVariableInteger("Radio", "Radio", "Radio.SONOS", 21);
$this->RegisterVariableInteger("Status", "Status", "Status.SONOS", 29);
$this->RegisterVariableInteger("Volume", "Volume", "Volume.SONOS", 30);
$this->EnableAction("Radio");
$this->EnableAction("Status");
$this->EnableAction("Volume");
// 2) Add/Remove according to feature activation
// create link list for deletion of liks if target is deleted
$links = array();
foreach (IPS_GetLinkList() as $key => $LinkID) {
$links[] = array('LinkID' => $LinkID, 'TargetID' => IPS_GetLink($LinkID)['TargetID']);
}
// 2a) Bass
if ($this->ReadPropertyBoolean("BassControl")) {
$this->RegisterVariableInteger("Bass", "Bass", "Tone.SONOS", 36);
$this->EnableAction("Bass");
} else {
$this->removeVariableAction("Bass", $links);
}
// 2b) Treble
if ($this->ReadPropertyBoolean("TrebleControl")) {
$this->RegisterVariableInteger("Treble", "Treble", "Tone.SONOS", 37);
$this->EnableAction("Treble");
} else {
$this->removeVariableAction("Treble", $links);
}
// 2c) Mute
if ($this->ReadPropertyBoolean("MuteControl")) {
$this->RegisterVariableInteger("Mute", "Mute", "Switch.SONOS", 31);
$this->EnableAction("Mute");
} else {
$this->removeVariableAction("Mute", $links);
}
// 2d) Loudness
if ($this->ReadPropertyBoolean("LoudnessControl")) {
$this->RegisterVariableInteger("Loudness", "Loudness", "Switch.SONOS", 35);
$this->EnableAction("Loudness");
} else {
$this->removeVariableAction("Loudness", $links);
}
// 2e) Balance
if ($this->ReadPropertyBoolean("BalanceControl")) {
$this->RegisterVariableInteger("Balance", "Balance", "Balance.SONOS", 38);
$this->EnableAction("Balance");
} else {
$this->removeVariableAction("Balance", $links);
}
// 2f Sleeptimer
if ($this->ReadPropertyBoolean("SleeptimerControl")) {
$this->RegisterVariableInteger("Sleeptimer", "Sleeptimer", "", 39);
} else {
$this->removeVariable("Sleeptimer", $links);
}
// 2g Playlists
if ($this->ReadPropertyBoolean("PlaylistControl")) {
if (!IPS_VariableProfileExists("Playlist.SONOS")) {
$this->RegisterProfileIntegerEx("Playlist.SONOS", "Database", "", "", array());
}
$this->RegisterVariableInteger("Playlist", "Playlist", "Playlist.SONOS", 22);
$this->EnableAction("Playlist");
} else {
$this->removeVariable("Playlist", $links);
}
// 2h) GroupVolume, GroupMembers, MemberOfGroup
if ($this->ReadPropertyBoolean("GroupCoordinator")) {
IPS_SetHidden($this->RegisterVariableString("GroupMembers", "GroupMembers", "", 10), true);
$this->RegisterVariableInteger("GroupVolume", "GroupVolume", "Volume.SONOS", 11);
$this->EnableAction("GroupVolume");
$this->removeVariableAction("MemberOfGroup", $links);
} else {
$this->RegisterVariableInteger("MemberOfGroup", "MemberOfGroup", "Groups.SONOS", 12);
$this->EnableAction("MemberOfGroup");
$this->removeVariableAction("GroupVolume", $links);
$this->removeVariable("GroupMembers", $links);
}
// 2i) Hide/unhide MemberOfGroup depending on presence of GroupCoordinators
if (sizeof($GroupAssociations) === 1) {
// hide MemberOfGroup
foreach ($allSonosInstances as $key => $SonosID) {
$GroupingID = @IPS_GetVariableIDByName("MemberOfGroup", $SonosID);
if ($GroupingID) {
IPS_SetHidden($GroupingID, true);
}
}
} else {
// unhide MemberOfGroup
foreach ($allSonosInstances as $key => $SonosID) {
$GroupingID = @IPS_GetVariableIDByName("MemberOfGroup", $SonosID);
if ($GroupingID) {
IPS_SetHidden($GroupingID, false);
}
}
}
// End Register variables and Actions
// Start add scripts for regular status and grouping updates
// 1) _updateStatus
$statusScriptID = @$this->GetIDForIdent("_updateStatus");
if ($statusScriptID === false) {
$statusScriptID = $this->RegisterScript("_updateStatus", "_updateStatus", file_get_contents(__DIR__ . "/_updateStatus.php"), 98);
} else {
IPS_SetScriptContent($statusScriptID, file_get_contents(__DIR__ . "/_updateStatus.php"));
}
IPS_SetHidden($statusScriptID, true);
IPS_SetScriptTimer($statusScriptID, 5);
// 2) _updateGrouping
$groupingScriptID = @$this->GetIDForIdent("_updateGrouping");
if ($groupingScriptID === false) {
$groupingScriptID = $this->RegisterScript("_updateGrouping", "_updateGrouping", file_get_contents(__DIR__ . "/_updateGrouping.php"), 99);
} else {
IPS_SetScriptContent($groupingScriptID, file_get_contents(__DIR__ . "/_updateGrouping.php"));
}
IPS_SetHidden($groupingScriptID, true);
IPS_SetScriptTimer($groupingScriptID, 300);
// End add scripts for regular status and grouping updates
}
public function ApplyChanges()
{
// get instance id
$instanceid = IPS_GetInstance($this->InstanceID)['InstanceID'];
// rename instance
$room = $this->ReadPropertyString("Room");
if ($room != "") {
IPS_SetName($instanceid, $room);
}
// check device
$deviceip = $this->ReadPropertyString("DeviceIP");
$timeout = $this->ReadPropertyString("Timeout");
if ($deviceip != "") {
// check device availability
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
// throw new Exception("Device ".$deviceip." is not available");
die("Unable to connect to device {$deviceip}");
}
include_once __DIR__ . "/bose_soundtouch_api.php";
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->getDeviceNowPlayingAPI();
// get device id for multiroom
$deviceid = $this->ReadPropertyString("DeviceID");
if ($deviceid == "" and $deviceip != "") {
$deviceid = $result['deviceid'];
IPS_SetProperty($instanceid, "DeviceID", "" . $deviceid . "");
if (IPS_HasChanges($instanceid)) {
IPS_ApplyChanges($instanceid);
}
}
}
// never delete this line!
parent::ApplyChanges();
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// create profiles
/////////////////////////////////////////////////////////////////////////////////////////////////////////
//create zone profiles for multiroom
$allboseinstances = IPS_GetInstanceListByModuleID("{4836EF46-FF79-4D6A-91C9-FE54F1BDF2DB}");
// create profile for each instance / device
foreach ($allboseinstances as $key => $instanceid) {
$multiroomprofilename = "bose.Device" . $instanceid . "MasterZones";
// delete zone profiles
if (IPS_VariableProfileExists($multiroomprofilename)) {
IPS_DeleteVariableProfile($multiroomprofilename);
}
IPS_CreateVariableProfile($multiroomprofilename, 1);
// set values for profile
foreach ($allboseinstances as $key => $value) {
if ($instanceid == $value) {
IPS_SetVariableProfileAssociation($multiroomprofilename, "0", "Off", "", 0xff);
} else {
$instancename = IPS_GetName($value);
if ($instancename != "") {
IPS_SetVariableProfileAssociation($multiroomprofilename, "" . ($key + 1) . "", "" . $instancename . "", "", 0xff);
}
}
}
}
// create volume slider profile
$volumesliderprofilename = "bose.VolumeSlider";
if (!IPS_VariableProfileExists($volumesliderprofilename)) {
IPS_CreateVariableProfile($volumesliderprofilename, 1);
}
IPS_SetVariableProfileValues($volumesliderprofilename, 0, 100, 1);
IPS_SetVariableProfileText($volumesliderprofilename, "", "%");
IPS_SetVariableProfileIcon($volumesliderprofilename, "Speaker");
// play pause preset
$playpauseprofilename = "bose.PlayPause";
if (!IPS_VariableProfileExists($playpauseprofilename)) {
IPS_CreateVariableProfile($playpauseprofilename, 1);
}
IPS_SetVariableProfileAssociation($playpauseprofilename, "0", "Pause", "", 0xff);
IPS_SetVariableProfileAssociation($playpauseprofilename, "1", "Play", "", 0xff);
IPS_SetVariableProfileIcon($playpauseprofilename, "HollowArrowRight");
// create presets and radiolocations profiles
$instanceid = IPS_GetInstance($this->InstanceID)['InstanceID'];
$radiostationsprofilename = "bose.Device" . $instanceid . "RadioStations";
if (!IPS_VariableProfileExists($radiostationsprofilename)) {
IPS_CreateVariableProfile($radiostationsprofilename, 1);
}
$radiolocationsprofilename = "bose.Device" . $instanceid . "RadioLocations";
if (!IPS_VariableProfileExists($radiolocationsprofilename)) {
IPS_CreateVariableProfile($radiolocationsprofilename, 1);
}
// get device presets
if ($deviceip != "") {
include_once __DIR__ . "/bose_soundtouch_api.php";
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->getDevicePresetsAPI();
for ($i = 0; $i < 6; $i++) {
$value = $i + 1;
$radiostationname = $result->preset[$i]->ContentItem->itemName;
$radiostationlocation = $result->preset[$i]->ContentItem["location"];
IPS_SetVariableProfileAssociation($radiostationsprofilename, "" . $value . "", "" . $radiostationname . "", "", 0xff);
IPS_SetVariableProfileAssociation($radiolocationsprofilename, "" . $value . "", "" . $radiostationlocation . "", "", 0xff);
}
IPS_SetVariableProfileIcon($radiostationsprofilename, "Cloud");
}
// create timer hour profile
$timerhourprofilename = "bose.TimerHour";
if (!IPS_VariableProfileExists($timerhourprofilename)) {
IPS_CreateVariableProfile($timerhourprofilename, 1);
}
$i = 0;
for ($i = 0; $i < 24; $i++) {
IPS_SetVariableProfileAssociation($timerhourprofilename, $i, $i, "", 0xff);
}
IPS_SetVariableProfileIcon($timerhourprofilename, "Clock");
// create timer minute profile
$timerminuteprofilename = "bose.TimerMinute";
if (!IPS_VariableProfileExists($timerminuteprofilename)) {
IPS_CreateVariableProfile($timerminuteprofilename, 1);
}
$i = 0;
for ($i = 0; $i <= 55; $i = $i + 5) {
IPS_SetVariableProfileAssociation($timerminuteprofilename, $i, $i, "", 0xff);
}
IPS_SetVariableProfileIcon($timerminuteprofilename, "Clock");
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// register variables
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// device power
$this->RegisterVariableBoolean("DevicePower", "Device Power", "~Switch", 1);
$this->EnableAction("DevicePower");
SetValue($this->GetIDForIdent("DevicePower"), 0);
// volume slider
$this->RegisterVariableInteger("VolumeSlider", "Volume", "bose.VolumeSlider", 2);
$this->EnableAction("VolumeSlider");
SetValue($this->GetIDForIdent("VolumeSlider"), 10);
// play pause
$this->RegisterVariableInteger("PlayPause", "Play / Pause", "bose.PlayPause", 3);
$this->EnableAction("PlayPause");
SetValue($this->GetIDForIdent("PlayPause"), true);
// join zone (multiroom)
$instanceid = IPS_GetInstance($this->InstanceID)['InstanceID'];
$this->RegisterVariableInteger("JoinZone", "Join Zone (MultiRoom)", "bose.Device" . $instanceid . "MasterZones", 4);
$this->EnableAction("JoinZone");
IPS_SetIcon($this->GetIDForIdent("JoinZone"), "Network");
SetValue($this->GetIDForIdent("JoinZone"), 0);
// radio
$this->RegisterVariableInteger("Radio", "Radio", "bose.Device" . $instanceid . "RadioStations", 5);
$this->EnableAction("Radio");
SetValue($this->GetIDForIdent("Radio"), 1);
// device mode
$this->RegisterVariableString("DeviceMode", "Device Mode", "", 7);
IPS_SetIcon($this->GetIDForIdent("DeviceMode"), "Information");
// device state
$this->RegisterVariableString("DeviceState", "Device State", "", 8);
IPS_SetIcon($this->GetIDForIdent("DeviceState"), "Information");
// now playing
$this->RegisterVariableString("NowPlaying", "Now Playing", "", 9);
IPS_SetIcon($this->GetIDForIdent("NowPlaying"), "Information");
// description
$this->RegisterVariableString("Description", "Description", "", 10);
IPS_SetIcon($this->GetIDForIdent("Description"), "Information");
// logo
$this->RegisterVariableString("Logo", "Logo", "~HTMLBox", 11);
IPS_SetIcon($this->GetIDForIdent("Logo"), "Information");
// timer hour
$this->RegisterVariableInteger("TimerHour", "Timer Hour", "bose.TimerHour", 12);
$this->EnableAction("TimerHour");
SetValue($this->GetIDForIdent("TimerHour"), 12);
// timer minute
$this->RegisterVariableInteger("TimerMinute", "Timer Minute", "bose.TimerMinute", 13);
$this->EnableAction("TimerMinute");
SetValue($this->GetIDForIdent("TimerMinute"), 0);
// alarm clock
$this->RegisterVariableBoolean("AlarmClock", "Alarm Clock", "~Switch", 14);
$this->EnableAction("AlarmClock");
SetValue($this->GetIDForIdent("AlarmClock"), false);
// volume fade in
$this->RegisterVariableBoolean("VolumeFadeIn", "Volume Fade In (15 min)", "~Switch", 15);
$this->EnableAction("VolumeFadeIn");
SetValue($this->GetIDForIdent("VolumeFadeIn"), false);
// next power on
$this->RegisterVariableString("NextPowerOn", "Next Power On", "", 16);
IPS_SetIcon($this->GetIDForIdent("NextPowerOn"), "Information");
// alarm cycle
IPS_SetHidden($this->RegisterVariableString("AlarmCycle", "Alarm Cycle", "", 17), true);
SetValue($this->GetIDForIdent("AlarmCycle"), 0);
// alarm radio station
IPS_SetHidden($this->RegisterVariableString("AlarmRadioStation", "Alarm Radio Station", "", 18), true);
SetValue($this->GetIDForIdent("VolumeFadeIn"), false);
// alarm clock volume
IPS_SetHidden($this->RegisterVariableInteger("AlarmClockVolume", "Alarm Clock Volume", "bose.VolumeSlider", 19), true);
SetValue($this->GetIDForIdent("AlarmRadioStation"), "");
// sleep timer
$this->RegisterVariableBoolean("SleepTimer", "Sleep Timer", "~Switch", 20);
$this->EnableAction("SleepTimer");
SetValue($this->GetIDForIdent("SleepTimer"), false);
// volume fade out
$this->RegisterVariableBoolean("VolumeFadeOut", "Volume Fade Out (15 min)", "~Switch", 21);
$this->EnableAction("VolumeFadeOut");
SetValue($this->GetIDForIdent("VolumeFadeOut"), false);
// good night
$this->RegisterVariableBoolean("GoodNight", "Good Night (30 min)", "~Switch", 22);
IPS_SetIcon($this->GetIDForIdent("GoodNight"), "Moon");
$this->EnableAction("GoodNight");
SetValue($this->GetIDForIdent("GoodNight"), false);
// next power off
$this->RegisterVariableString("NextPowerOff", "Next Power Off", "", 23);
IPS_SetIcon($this->GetIDForIdent("NextPowerOff"), "Information");
SetValue($this->GetIDForIdent("NextPowerOff"), "");
// sleep cycle
IPS_SetHidden($this->RegisterVariableString("SleepCycle", "Sleep Cycle", "", 24), true);
SetValue($this->GetIDForIdent("SleepCycle"), 0);
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// create scripts
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// device information script
$DeviceInformationControlScript = '<?
/*
SymconBoseSoundTouch
Bose SoundTouch Module for IP-Symcon
filename: DeviceInformationControl.php
description: Device Information Control Script
version 1.0.1
date: 13.01.2016
publisher: Copyright (c) 2015, 2016 Ulrich Bittner
license: CC BY-NC 4.0 Creative Commons Attribution-NonCommercial 4.0 International License
environment: IP-Symcon 4.0 (beta) on RPi
changelog: version 1.0.1 13.01.2016 multiroom fix for single device
version 1.0.0 28.12.2015 initialscript
todo: (none)
github: https://github.com/ubittner/SymconBoseSoundTouch.git
symcon forum: https://www.symcon.de/forum/threads/29922-Bose-SoundTouch-Modul
*/
if ($_IPS["SENDER"] == "Execute") {
addRadioStations();
}
if ($_IPS["SENDER"] == "TimerEvent") {
getDeviceInformation();
}
function addRadioStations()
{
// Radio Stations
// if you want less radio stations, delete the unnecessary positions
// if you want to have more radio stations, add positions
// get the radio station location id from www.vtuner.com
// http://vtuner.com/setupapp/guide/asp/BrowseStations/startpage.asp
// example for WDR 2 Ruhrgebiet
// url: http://www.vtuner.com/vtunerweb/mms/m3u32760.m3u
// location = 32760
// Radio Station 7
$RadioStations["station7"]["name"] = "AH.FM";
$RadioStations["station7"]["location"] = "24836";
// Radio Station 8
$RadioStations["station8"]["name"] = "Sunshine Live Classics";
$RadioStations["station8"]["location"] = "44882";
// Radio Station 9
$RadioStations["station9"]["name"] = "Sunshine Live Trance";
$RadioStations["station9"]["location"] = "48651";
// Radio Station 10
$RadioStations["station10"]["name"] = "Sunshine Live Be Easy";
$RadioStations["station10"]["location"] = "44879";
// Radio Station 11
$RadioStations["station11"]["name"] = "Sunshine Live Be DJ";
$RadioStations["station11"]["location"] = "44881";
// Radio Station 12
$RadioStations["station12"]["name"] = "Sunshine Live Radioclub";
$RadioStations["station12"]["location"] = "62373";
// Radio Station 13
$RadioStations["station13"]["name"] = "SPORT1.fm";
$RadioStations["station13"]["location"] = "52773";
// Radio Station 14
$RadioStations["station14"]["name"] = "SPORT1.fm Spiel1";
$RadioStations["station14"]["location"] = "53341";
// Radio Station 15
$RadioStations["station15"]["name"] = "SPORT1.fm Spiel2";
$RadioStations["station15"]["location"] = "53343";
// Radio Station 16
$RadioStations["station16"]["name"] = "SPORT1.fm Spiel3";
$RadioStations["station16"]["location"] = "53344";
// Radio Station 17
$RadioStations["station17"]["name"] = "SPORT1.fm Spiel4";
$RadioStations["station17"]["location"] = "53346";
// Radio Station 18
$RadioStations["station18"]["name"] = "SPORT1.fm Spiel5";
$RadioStations["station18"]["location"] = "53347";
// Radio Station 19
$RadioStations["station19"]["name"] = "SPORT1.fm Spiel6";
$RadioStations["station19"]["location"] = "53349";
// Radio Station 20
$RadioStations["station20"]["name"] = "WDR2 Ruhrgebiet";
$RadioStations["station20"]["location"] = "32760";
// Radio Station 21
$RadioStations["station21"]["name"] = "BFBS Germany";
$RadioStations["station21"]["location"] = "35142";
// extend radio station and radio location profile
$instanceid = IPS_GetParent($_IPS["SELF"]);
$presetprofilename = "bose.Device".$instanceid."RadioStations";
$radiolocationsprofilename = "bose.Device".$instanceid."RadioLocations";
$variable = $RadioStations;
$i = 7;
foreach ($variable as $key => $value) {
$radiostationname = $value["name"];
$radiostationlocation = $value["location"];
IPS_SetVariableProfileAssociation($presetprofilename, "".$i."", "".$radiostationname."", "", 0x0000FF);
IPS_SetVariableProfileAssociation($radiolocationsprofilename, "".$i."", "".$radiostationlocation."", "", 0x0000FF);
$i++;
}
}
function getDeviceInformation()
{
$deviceip = IPS_GetProperty(IPS_GetParent($_IPS["SELF"]), "DeviceIP");
$timeout = IPS_GetProperty(IPS_GetParent($_IPS["SELF"]), "Timeout");
$instanceid = IPS_GetParent($_IPS["SELF"]);
if ($deviceip == "") {
die;
}
try {
// check device availibility
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
throw new Exception("Device ".$deviceip." is not available");
}
include_once("../modules/SymconBoseSoundTouch/Bose/bose_soundtouch_api.php");
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->getDeviceNowPlayingAPI();
// power switch
if ($result["devicemode"] == "Standby") {
$powerstate = false;
}
else {
$powerstate = true;
}
$powerswitch = GetValue(IPS_GetObjectIDByName("Device Power", IPS_GetParent($_IPS["SELF"])));
if ($powerstate <> $powerswitch) {
SetValue(IPS_GetObjectIDByName("Device Power", IPS_GetParent($_IPS["SELF"])), $powerstate);
}
// device mode
$devicemode = GetValue(IPS_GetObjectIDByName("Device Mode", IPS_GetParent($_IPS["SELF"])));
if ($result["devicemode"] <> $devicemode) {
SetValue(IPS_GetObjectIDByName("Device Mode", IPS_GetParent($_IPS["SELF"])), $result["devicemode"]);
}
// device state
$devicestate = GetValue(IPS_GetObjectIDByName("Device State", IPS_GetParent($_IPS["SELF"])));
if ($result["devicestate"] <> $devicestate) {
SetValue(IPS_GetObjectIDByName("Device State", IPS_GetParent($_IPS["SELF"])), $result["devicestate"]);
}
// now playing
$nowplaying = GetValue(IPS_GetObjectIDByName("Now Playing", IPS_GetParent($_IPS["SELF"])));
if ($result["nowplaying"] <> $nowplaying) {
SetValue(IPS_GetObjectIDByName("Now Playing", IPS_GetParent($_IPS["SELF"])), $result["nowplaying"]);
$instanceid = IPS_GetParent($_IPS["SELF"]);
$associations = IPS_GetVariableProfile("bose.Device".$instanceid."RadioStations")["Associations"];
$index = 0;
foreach($associations as $key => $value) {
if ($value["Name"] == $result["nowplaying"]) {
$index = $value["Value"];
}
}
if ($index <> 0){
SetValue(IPS_GetObjectIDByName("Radio", IPS_GetParent($_IPS["SELF"])), $index);
}
}
// description
$description = GetValue(IPS_GetObjectIDByName("Description", IPS_GetParent($_IPS["SELF"])));
if ($result["description"] <> $description) {
SetValue(IPS_GetObjectIDByName("Description", IPS_GetParent($_IPS["SELF"])), $result["description"]);
}
// logo
$logo = GetValue(IPS_GetObjectIDByName("Logo", IPS_GetParent($_IPS["SELF"])));
if ($result["logourl"] <> $logo) {
SetValue(IPS_GetObjectIDByName("Logo", IPS_GetParent($_IPS["SELF"])), $result["logourl"]);
}
// volume
$result = $bosedevice->getDeviceVolumeAPI();
$volumeslider = GetValue(IPS_GetObjectIDByName("Volume", IPS_GetParent($_IPS["SELF"])));
if ($result["actualvolume"] <> $volumeslider) {
SetValue(IPS_GetObjectIDByName("Volume", IPS_GetParent($_IPS["SELF"])), $result["actualvolume"]);
}
// zone
$allboseinstances = IPS_GetInstanceListByModuleID("{4836EF46-FF79-4D6A-91C9-FE54F1BDF2DB}");
$numberofdevices = count($allboseinstances);
if ($numberofdevices >1) {
$result = $bosedevice->getDeviceZoneAPI();
$zonemasterid = $result["zonemasterid"];
$zonememberid = $result["zonememberid"];
$deviceid = IPS_GetProperty(IPS_GetParent($_IPS["SELF"]), "DeviceID");
$zonemembers = $result["zonememberid"];
$zonemember = false;
$masterzone = 0;
foreach ($zonemembers as $key => $value) {
// device is member
if ($value == $deviceid) {
// device is the master
if ($zonemasterid == $deviceid) {
$masterzone = 0;
}
// get zone master
else {
$allboseinstances = IPS_GetInstanceListByModuleID("{4836EF46-FF79-4D6A-91C9-FE54F1BDF2DB}");
foreach ($allboseinstances as $key => $value) {
$masterdeviceid = IPS_GetProperty($value, "DeviceID");
if ($masterdeviceid == $zonemasterid) {
$zonemastername = IPS_GetName($value);
}
}
$associations = IPS_GetVariableProfile("bose.Device".$instanceid."MasterZones")["Associations"];
foreach($associations as $key => $value) {
if ($value["Name"] == $zonemastername) {
$masterzone = $value["Value"];
}
}
}
}
}
$zonestate = GetValue(IPS_GetObjectIDByName("Join Zone (MultiRoom)", IPS_GetParent($_IPS["SELF"])));
if ($masterzone <> $zonestate) {
SetValue(IPS_GetObjectIDByName("Join Zone (MultiRoom)", IPS_GetParent($_IPS["SELF"])), $masterzone);
}
}
}
// error message
catch (Exception $e) {
echo $e->getMessage();
}
}
?>';
// create script
$deviceinformationcontrolscriptid = @$this->GetIDForIdent("DeviceInformationControl");
if ($deviceinformationcontrolscriptid === false) {
$deviceinformationcontrolscriptid = $this->RegisterScript("DeviceInformationControl", "DeviceInformationControl", $DeviceInformationControlScript, 0);
} else {
IPS_SetScriptContent($deviceinformationcontrolscriptid, $DeviceInformationControlScript);
}
IPS_SetHidden($deviceinformationcontrolscriptid, true);
IPS_SetScriptTimer($deviceinformationcontrolscriptid, 5);
// alarm clock script
$AlarmClockControlScript = '<?
/*
SymconBoseSoundTouch
Bose SoundTouch Module for IP-Symcon
filename: AlarmClockControl.php
description: Alarm Clock Control Script
version 1.0.0
date: 28.12.2015
publisher: Copyright (c) 2015, 2016 Ulrich Bittner
license: CC BY-NC 4.0 Creative Commons Attribution-NonCommercial 4.0 International License
environment: IP-Symcon 4.0 (beta) on RPi
changelog: version 1.0.0 28.12.2015 initialscript
todo: (none)
github: https://github.com/ubittner/SymconBoseSoundTouch.git
symcon forum: https://www.symcon.de/forum/threads/29922-Bose-SoundTouch-Modul
*/
// variable definitions
$instanceid = IPS_GetParent(IPS_GetParent($_IPS["SELF"]));
$deviceip = IPS_GetProperty($instanceid, "DeviceIP");
$timeout = IPS_GetProperty($instanceid, "Timeout");
$alarmclockscriptid = IPS_GetScriptIDByName("AlarmClockControl", IPS_GetParent($_IPS["SELF"]));
$alarmclockeventid = @IPS_GetEventIDByName("AlarmClockEvent", $alarmclockscriptid);
$alarmclockcycleseconds = GetValue(IPS_GetObjectIDByName("Alarm Cycle", $instanceid));
// get actual device mode
try {
// check device availibility
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
throw new Exception("Device ".$deviceip." is not available");
}
include_once("../modules/SymconBoseSoundTouch/Bose/bose_soundtouch_api.php");
$bosedevice = new BoseSoundTouchAPI($deviceip);
// get device mode
$result = $bosedevice->getDeviceNowPlayingAPI();
$devicemode = $result["devicemode"];
// get volume
$result = $bosedevice->getDeviceVolumeAPI();
SetValue(IPS_GetObjectIDByName("Volume", $instanceid), $result["actualvolume"]);
// power device on
if ($devicemode == "Standby"){
$result = $bosedevice->powerDeviceAPI();
// set radio station
$alarmradiostation = GetValue(IPS_GetObjectIDByName("Alarm Radio Station", $instanceid));
SetValue(IPS_GetObjectIDByName("Radio", $instanceid), $alarmradiostation);
$associations = IPS_GetVariableProfile("bose.Device".$instanceid."RadioLocations")["Associations"];
foreach($associations as $key => $value) {
if ($value["Value"] == $alarmradiostation) {
$location = $value["Name"];
}
}
$result = $bosedevice->setDeviceRadioStationAPI($location);
if ($alarmclockcycleseconds <> 0) {
$volume = 1;
$result = $bosedevice->setDeviceVolumeAPI($volume);
SetValue(IPS_GetObjectIDByName("Volume", $instanceid), $volume);
setNewEventCycleTime();
}
else {
switchAlarmClockOff();
}
SetValue(IPS_GetObjectIDByName("Device Power", $instanceid), true);
// get now playing
getnowplaying:
$result = $bosedevice->getDevicenowPlayingAPI();
if ($result["devicestate"] == "Reload") {
goto getnowplaying;
}
SetValue(IPS_GetObjectIDByName("Device Mode", $instanceid), $result["devicemode"]);
SetValue(IPS_GetObjectIDByName("Device State", $instanceid), $result["devicestate"]);
SetValue(IPS_GetObjectIDByName("Now Playing", $instanceid), $result["nowplaying"]);
SetValue(IPS_GetObjectIDByName("Description", $instanceid), $result["description"]);
SetValue(IPS_GetObjectIDByName("Logo", $instanceid), $result["logourl"]);
}
// device is already on
else {
if ($alarmclockcycleseconds <> 0) {
$actualvolume = GetValue(IPS_GetObjectIDByName("Volume", $instanceid));
$alarmclockvolume = GetValue(IPS_GetObjectIDByName("Alarm Clock Volume", $instanceid));
if ($actualvolume < $alarmclockvolume) {
$targetvolume = ($actualvolume+1);
$result = $bosedevice->setDeviceVolumeAPI($targetvolume);
SetValue(IPS_GetObjectIDByName("Volume", $instanceid), $targetvolume);
setNewEventCycleTime();
}
else {
switchAlarmClockOff();
}
}
}
}
// error message
catch (Exception $e) {
echo $e->getMessage();
}
// set new event cycle time
function setNewEventCycleTime()
{
global $alarmclockeventid,
$alarmclockcycleseconds;
$eventinfo = IPS_GetEvent($alarmclockeventid);
$eventtimestamp = ($eventinfo["NextRun"]);
$neweventtimestamp = strtotime("+ " .$alarmclockcycleseconds. " seconds", $eventtimestamp);
$newhour = date("H",$neweventtimestamp);
$newminute = date("i",$neweventtimestamp);
$newsecond = date("s",$neweventtimestamp);
IPS_SetEventCyclicTimeFrom($alarmclockeventid, $newhour, $newminute, $newsecond);
IPS_SetEventActive($alarmclockeventid, true);
}
// switch alarm clock off
function switchAlarmClockOff()
{
global $instanceid,
$alarmclockeventid;
SetValue(IPS_GetObjectIDByName("Alarm Clock", $instanceid), false);
IPS_SetEventActive($alarmclockeventid, false);
SetValue(IPS_GetObjectIDByName("Alarm Cycle", $instanceid), 0);
SetValue(IPS_GetObjectIDByName("Next Power On", $instanceid), "");
}
?>';
// create script
$alarmclockvariableid = @$this->GetIDForIdent("AlarmClock");
$alarmclockcontrolscriptid = @IPS_GetScriptIDByName("AlarmClockControl", $alarmclockvariableid);
if ($alarmclockcontrolscriptid === false) {
$alarmclockcontrolscriptid = $this->RegisterScript("AlarmClockControl", "AlarmClockControl", $AlarmClockControlScript, 0);
} else {
IPS_SetScriptContent($alarmclockcontrolscriptid, $AlarmClockControlScript);
}
IPS_SetParent($alarmclockcontrolscriptid, $alarmclockvariableid);
IPS_SetHidden($alarmclockcontrolscriptid, true);
$alarmclockscripteventid = @IPS_GetEventIDByName("AlarmClockEvent", $alarmclockcontrolscriptid);
if ($alarmclockscripteventid == false) {
$alarmclockscripteventid = IPS_CreateEvent(1);
IPS_SetParent($alarmclockscripteventid, $alarmclockcontrolscriptid);
IPS_SetName($alarmclockscripteventid, "AlarmClockEvent");
}
// SleepTimer Script
$SleepTimerControlScript = '<?
/*
SymconBoseSoundTouch
Bose SoundTouch Module for IP-Symcon
filename: SleepTimerControl.php
description: Sleep Timer Control Script
version 1.0.0
date: 28.12.2015
publisher: Copyright (c) 2015, 2016 Ulrich Bittner
license: CC BY-NC 4.0 Creative Commons Attribution-NonCommercial 4.0 International License
environment: IP-Symcon 4.0 (beta) on RPi
changelog: version 1.0.0 28.12.2015 initialscript
todo: (none)
github: https://github.com/ubittner/SymconBoseSoundTouch.git
symcon forum: https://www.symcon.de/forum/threads/29922-Bose-SoundTouch-Modul
*/
$instanceid = IPS_GetParent(IPS_GetParent($_IPS["SELF"]));
$deviceip = IPS_GetProperty($instanceid, "DeviceIP");
$timeout = IPS_GetProperty($instanceid, "Timeout");
$sleepcycle = GetValue(IPS_GetObjectIDByName("Sleep Cycle", $instanceid));
$sleeptimerscriptid = IPS_GetScriptIDByName("SleepTimerControl", IPS_GetParent($_IPS["SELF"]));
$sleeptimereventid = @IPS_GetEventIDByName("SleepTimerEvent", $sleeptimerscriptid);
include_once("../modules/SymconBoseSoundTouch/Bose/bose_soundtouch_api.php");
try {
// check device availibility
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
throw new Exception("Device ".$deviceip." is not available");
}
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->getDevicenowPlayingAPI();
// device is on
if ($result["devicestate"] == "Play"){
if ($sleepcycle <> 0) {
decreaseVolume();
}
else {
switchDeviceOff();
}
}
// device is already off
else {
resetValues();
}
}
// error message
catch (Exception $e) {
echo $e->getMessage();
}
// decrease volume
function decreaseVolume()
{
global $deviceip,
$timeout,
$sleeptimereventid,
$instanceid,
$sleepcycle;
try {
// check device availibility
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
throw new Exception("Device ".$deviceip." is not available");
}
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->getDeviceVolumeAPI();
if ($result["actualvolume"] == 1) {
switchDeviceOff();
IPS_SetEventActive($sleeptimereventid, false);
}
else {
$volume = ($result["actualvolume"])-1;
$setvolume = $bosedevice->setDeviceVolumeAPI($volume);
SetValue(IPS_GetObjectIDByName("Volume", $instanceid), $volume);
$eventinfo = IPS_GetEvent($sleeptimereventid);
$eventtimestamp = ($eventinfo["NextRun"]);
$neweventtimestamp = strtotime("+ " . $sleepcycle . " seconds", $eventtimestamp);
$newhour = date("H",$neweventtimestamp);
$newminute = date("i",$neweventtimestamp);
$newsecond = date("s",$neweventtimestamp);
IPS_SetEventCyclicTimeFrom($sleeptimereventid, $newhour, $newminute, $newsecond);
}
}
// error message
catch (Exception $e) {
echo $e->getMessage();
}
}
// switch device off
function switchDeviceOff()
{
global $deviceip,
$timeout;
// power off
try {
if ($timeout && Sys_Ping($deviceip, $timeout) != true) {
throw new Exception("Device ".$deviceip." is not available");
}
$bosedevice = new BoseSoundTouchAPI($deviceip);
$result = $bosedevice->powerDeviceAPI();
resetValues();
}
// error message
catch (Exception $e) {
echo $e->getMessage();
}
}
// reset values
function resetValues()
{
global $instanceid,
$sleeptimereventid;
SetValue(IPS_GetObjectIDByName("Device Power", $instanceid), false);
SetValue(IPS_GetObjectIDByName("Device Mode", $instanceid), "");
SetValue(IPS_GetObjectIDByName("Device State", $instanceid), "");
SetValue(IPS_GetObjectIDByName("Now Playing", $instanceid), "");
SetValue(IPS_GetObjectIDByName("Description", $instanceid), "");
SetValue(IPS_GetObjectIDByName("Logo", $instanceid), "");
SetValue(IPS_GetObjectIDByName("Sleep Timer", $instanceid), false);
SetValue(IPS_GetObjectIDByName("Volume Fade Out (15 min)", $instanceid), false);
SetValue(IPS_GetObjectIDByName("Good Night (30 min)", $instanceid), false);
SetValue(IPS_GetObjectIDByName("Sleep Cycle", $instanceid), 0);
SetValue(IPS_GetObjectIDByName("Next Power Off", $instanceid), "");
IPS_SetEventActive($sleeptimereventid, false);
}
?>';
$sleeptimervariableid = @$this->GetIDForIdent("SleepTimer");
$sleeptimercontrolscriptid = @IPS_GetScriptIDByName("SleepTimerControl", $sleeptimervariableid);
if ($sleeptimercontrolscriptid === false) {
$sleeptimercontrolscriptid = $this->RegisterScript("SleepTimerControl", "SleepTimerControl", $SleepTimerControlScript, 0);
} else {
IPS_SetScriptContent($sleeptimercontrolscriptid, $SleepTimerControlScript);
}
IPS_SetParent($sleeptimercontrolscriptid, $sleeptimervariableid);
IPS_SetHidden($sleeptimercontrolscriptid, true);
$sleeptimerscripteventid = @IPS_GetEventIDByName("SleepTimerEvent", $sleeptimercontrolscriptid);
if ($sleeptimerscripteventid == false) {
$sleeptimerscripteventid = IPS_CreateEvent(1);
IPS_SetParent($sleeptimerscripteventid, $sleeptimercontrolscriptid);
IPS_SetName($sleeptimerscripteventid, "SleepTimerEvent");
}
}