mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-04-15 22:26:04 +00:00
Milight: Add new modules 30_MilightBridge and 31_MilightDevice
git-svn-id: https://svn.fhem.de/fhem/trunk@7308 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
mattwire
parent
c954556eb7
commit
8202b8246b
@ -1,5 +1,7 @@
|
||||
# Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
|
||||
# Do not insert empty lines here, update check depends on it.
|
||||
- added: 30_MilightBridge / 31_MilightDevice: Support Milight
|
||||
(Applamp/LimitlessLED/EasyBulb) LED lights/strips/controllers.
|
||||
- feature: HUEDevice: allow ct presets in webCmd
|
||||
new subTypes extcolordimer and ctdimer
|
||||
start support for Lightify bulbs
|
||||
|
||||
392
fhem/FHEM/30_MilightBridge.pm
Normal file
392
fhem/FHEM/30_MilightBridge.pm
Normal file
@ -0,0 +1,392 @@
|
||||
# $Id$
|
||||
##############################################
|
||||
#
|
||||
# 30_MilightBridge.pm (Use with 31_MilightDevice.pm)
|
||||
# FHEM module for Milight Wifi bridges which control Milight lightbulbs.
|
||||
#
|
||||
# Author: Matthew Wire (mattwire)
|
||||
#
|
||||
# This file is part of fhem.
|
||||
#
|
||||
# Fhem is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Fhem is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with fhem. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
##############################################################################
|
||||
|
||||
package main;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use IO::Handle;
|
||||
use IO::Socket;
|
||||
use IO::Select;
|
||||
use Time::HiRes;
|
||||
use Net::Ping;
|
||||
|
||||
sub MilightBridge_Initialize($)
|
||||
{
|
||||
my ($hash) = @_;
|
||||
|
||||
# Provider
|
||||
# $hash->{ReadFn} = "MilightBridge_Read";
|
||||
$hash->{WriteFn} = "MilightBridge_Write";
|
||||
|
||||
#Consumer
|
||||
$hash->{DefFn} = "MilightBridge_Define";
|
||||
$hash->{UndefFn} = "MilightBridge_Undefine";
|
||||
$hash->{NotifyFn} = "MilightBridge_Notify";
|
||||
$hash->{AttrFn} = "MilightBridge_Attr";
|
||||
$hash->{AttrList} = "port sendInterval disable:0,1 ".$readingFnAttributes;
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Define bridge device
|
||||
sub MilightBridge_Define($$)
|
||||
{
|
||||
my ($hash, $def) = @_;
|
||||
my @args = split("[ \t][ \t]*", $def);
|
||||
|
||||
return "Usage: define <name> MilightBridge <host/ip>" if(@args < 3);
|
||||
|
||||
my ($name, $type, $host) = @args;
|
||||
|
||||
$hash->{Clients} = ":MilightDevice:";
|
||||
my %matchList = ( "1:MilightDevice" => ".*" );
|
||||
$hash->{MatchList} = \%matchList;
|
||||
|
||||
# Parameters
|
||||
$hash->{HOST} = $host;
|
||||
# Set Port (Default 8899, old bridge (V2) uses 50000
|
||||
$attr{$name}{"port"} = "8899" if (!defined($attr{$name}{"port"}));
|
||||
$hash->{PORT} = $attr{$name}{"port"};
|
||||
|
||||
# Create local socket
|
||||
my $sock = IO::Socket::INET-> new (
|
||||
PeerPort => 48899,
|
||||
Blocking => 0,
|
||||
Proto => 'udp',
|
||||
Broadcast => 1) or return "can't bind: $@";
|
||||
my $select = IO::Select->new($sock);
|
||||
$hash->{SOCKET} = $sock;
|
||||
$hash->{SELECT} = $select;
|
||||
|
||||
# Note: Milight API specifies 100ms bridge delay for sending commands
|
||||
# Define sendInterval
|
||||
$attr{$name}{"sendInterval"} = 100 if (!defined($attr{$name}{"sendInterval"}));
|
||||
$hash->{INTERVAL} = $attr{$name}{"sendInterval"};
|
||||
|
||||
# Create command queue to hold commands
|
||||
my @cmdQueue = ();
|
||||
$hash->{cmdQueue} = \@cmdQueue;
|
||||
$hash->{cmdQueueLock} = 0;
|
||||
$hash->{cmdLastSent} = gettimeofday();
|
||||
|
||||
# Set Attributes
|
||||
$attr{$name}{"event-on-change-reading"} = "state" if (!defined($attr{$name}{"event-on-change-reading"}));
|
||||
|
||||
# Set state
|
||||
$hash->{SENDFAIL} = 0;
|
||||
MilightBridge_State($hash);
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Undefine Bridge device
|
||||
sub MilightBridge_Undefine($$)
|
||||
{
|
||||
my ($hash,$arg) = @_;
|
||||
RemoveInternalTimer($hash);
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Manage attribute changes
|
||||
sub MilightBridge_Attr($$$$) {
|
||||
my ($command,$name,$attribute,$value) = @_;
|
||||
my $hash = $defs{$name};
|
||||
|
||||
Log3 ($hash, 5, "$hash->{NAME}_Attr: Attr $attribute; Value $value");
|
||||
|
||||
# Handle "sendInterval" attribute which defaults to 100(ms)
|
||||
if ($attribute eq "sendInterval")
|
||||
{
|
||||
if (($value !~ /^\d*$/) || ($value < 1))
|
||||
{
|
||||
$attr{$name}{"sendInterval"} = 100;
|
||||
$hash->{INTERVAL} = $attr{$name}{"sendInterval"};
|
||||
return "sendInterval is required in ms (default: 100)";
|
||||
}
|
||||
else
|
||||
{
|
||||
$hash->{INTERVAL} = $attr{$name}{"sendInterval"};
|
||||
}
|
||||
}
|
||||
elsif ($attribute eq "port")
|
||||
{
|
||||
if (($value !~ /^\d*$/) || ($value < 1))
|
||||
{
|
||||
$attr{$name}{"port"} = 100;
|
||||
$hash->{PORT} = $attr{$name}{"port"};
|
||||
return "port is required as numeric (default: 8899)";
|
||||
}
|
||||
else
|
||||
{
|
||||
$hash->{PORT} = $attr{$name}{"port"};
|
||||
}
|
||||
}
|
||||
# Handle "disable" attribute by opening/closing connection to device
|
||||
elsif ($attribute eq "disable")
|
||||
{
|
||||
# Disable on 1, enable on anything else.
|
||||
if ($value eq "1")
|
||||
{
|
||||
$hash->{STATE} = "disabled";
|
||||
}
|
||||
else
|
||||
{
|
||||
$hash->{STATE} = "ok";
|
||||
}
|
||||
}
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Update slot information when a global notify event is fired
|
||||
sub MilightBridge_Notify($$)
|
||||
{
|
||||
my ($hash,$dev) = @_;
|
||||
Log3 ($hash, 5, "$hash->{NAME}_Notify: Triggered by $dev->{NAME}; @{$dev->{CHANGED}}");
|
||||
|
||||
return if($dev->{NAME} ne "global");
|
||||
|
||||
if(grep(m/^(INITIALIZED|REREADCFG|DEFINED.*|MODIFIED.*|DELETED.*)$/, @{$dev->{CHANGED}}))
|
||||
{
|
||||
MilightBridge_SlotUpdate($hash);
|
||||
}
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Update readings to show status of bridge
|
||||
sub MilightBridge_State(@)
|
||||
{
|
||||
# Update Bridge state
|
||||
my ($hash) = @_;
|
||||
|
||||
Log3 ( $hash, 5, "$hash->{NAME}_State: Checking Bridge Status");
|
||||
|
||||
# Do a ping check to see if bridge is reachable
|
||||
# check via ping
|
||||
my $pingstatus = "ok";
|
||||
my $p = Net::Ping->new('udp');
|
||||
if( $p->ping($hash->{HOST}, 2)) {
|
||||
$pingstatus = "ok";
|
||||
} else {
|
||||
$pingstatus = "unreachable";
|
||||
}
|
||||
$p->close();
|
||||
# And update state
|
||||
readingsSingleUpdate($hash, "state", $pingstatus, 1);
|
||||
|
||||
# Update send fail flag
|
||||
readingsSingleUpdate( $hash, "sendFail", $hash->{SENDFAIL}, 1 );
|
||||
|
||||
# Check state every 10 seconds
|
||||
InternalTimer(gettimeofday() + 10, "MilightBridge_State", $hash, 0);
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Update readings to show which slots have devices defined
|
||||
sub MilightBridge_SlotUpdate(@)
|
||||
{
|
||||
# Update readings to show what is connected to which slot
|
||||
my ($hash) = @_;
|
||||
|
||||
Log3 ( $hash, 5, "$hash->{NAME}_State: Updating Slot readings");
|
||||
|
||||
readingsBeginUpdate($hash);
|
||||
readingsBulkUpdate($hash, "slot0", (defined($hash->{0}->{NAME}) ? $hash->{0}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot1", (defined($hash->{1}->{NAME}) ? $hash->{1}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot2", (defined($hash->{2}->{NAME}) ? $hash->{2}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot3", (defined($hash->{3}->{NAME}) ? $hash->{3}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot4", (defined($hash->{4}->{NAME}) ? $hash->{4}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot5", (defined($hash->{5}->{NAME}) ? $hash->{5}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot6", (defined($hash->{6}->{NAME}) ? $hash->{6}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot7", (defined($hash->{7}->{NAME}) ? $hash->{7}->{NAME} : ""));
|
||||
readingsBulkUpdate($hash, "slot8", (defined($hash->{8}->{NAME}) ? $hash->{8}->{NAME} : ""));
|
||||
readingsEndUpdate($hash, 1);
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Device write function. Receives a command and triggers the send queue
|
||||
sub MilightBridge_Write(@)
|
||||
{
|
||||
# Client sent a new command
|
||||
my ($hash, $cmd) = @_;
|
||||
|
||||
Log3 ($hash, 3, "$hash->{NAME}_Write: Command not defined") if (!defined($cmd));
|
||||
my $hexStr = unpack("H*", $cmd || '');
|
||||
Log3 ($hash, 4, "$hash->{NAME}_Write: Command: $hexStr");
|
||||
|
||||
# Add command to queue
|
||||
push @{$hash->{cmdQueue}}, $cmd;
|
||||
|
||||
MilightBridge_CmdQueue_Send($hash);
|
||||
}
|
||||
|
||||
#####################################
|
||||
# Send a queued command to the bridge hardware
|
||||
sub MilightBridge_CmdQueue_Send(@)
|
||||
{
|
||||
my ($hash) = @_;
|
||||
|
||||
# Check that queue is not locked. If it is we should just return because another instance of this function has locked it.
|
||||
if ($hash->{cmdQueueLock} != 0)
|
||||
{
|
||||
Log3 ($hash, 5, "$hash->{NAME}_cmdQueue_Send: Send Queue Locked: cmdQueueLock = $hash->{cmdQueueLock}. Return.");
|
||||
return undef;
|
||||
}
|
||||
|
||||
# Check if we are called again before send interval has elapsed
|
||||
my $now = gettimeofday();
|
||||
if (($hash->{cmdLastSent} + ($hash->{INTERVAL} / 1000)) < $now)
|
||||
{
|
||||
# Lock cmdQueue
|
||||
$hash->{cmdQueueLock} = 1;
|
||||
|
||||
# Extract current command
|
||||
my $command = @{$hash->{cmdQueue}}[0];
|
||||
|
||||
# Check if we have any commands in queue
|
||||
if (!defined($command))
|
||||
{
|
||||
Log3 ($hash, 5, "$hash->{NAME}_cmdQueue_Send: No commands in queue");
|
||||
}
|
||||
else
|
||||
{
|
||||
# Send the command
|
||||
my $hexStr = unpack("H*", $command || '');
|
||||
Log3 ($hash, 5, "$hash->{NAME} send: $hexStr@".gettimeofday()."; Queue Length: ".@{$hash->{cmdQueue}});
|
||||
|
||||
# Check bridge is not disabled, and send command
|
||||
if (!IsDisabled($hash->{NAME}))
|
||||
{
|
||||
my $portaddr = sockaddr_in($hash->{PORT}, inet_aton($hash->{HOST}));
|
||||
if (!send($hash->{SOCKET}, $command, 0, $portaddr))
|
||||
{
|
||||
# Send failed
|
||||
Log3 ($hash, 3, "$hash->{NAME} Send FAILED! ".gettimeofday().":$hexStr. Queue Length: ".@{$hash->{cmdQueue}});
|
||||
$hash->{SENDFAIL} = 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
# Send successful
|
||||
$hash->{cmdLastSent} = gettimeofday(); # Update time last sent
|
||||
shift @{$hash->{cmdQueue}}; # transmission complete, remove command from queue
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
# We were called again before send interval elapsed
|
||||
Log3 ($hash, 5, "$hash->{NAME}_cmdQueue_Send: Waiting for send interval. cmdLastSent: $hash->{cmdLastSent}. Now: $now");
|
||||
}
|
||||
|
||||
# Unlock cmdQueue
|
||||
$hash->{cmdQueueLock} = 0;
|
||||
|
||||
# Set next cycle if there are commands in the queue
|
||||
if (@{$hash->{cmdQueue}} > 0)
|
||||
{
|
||||
# INTERVAL is in msec, need to add seconds to gettimeofday (eg 100/1000 = 0.1 seconds)
|
||||
#Log3 ($hash, 5, "$hash->{NAME}_cmdQueue_Send: cmdLastSent: $hash->{cmdLastSent}; Next: ".(gettimeofday()+($hash->{INTERVAL}/1000)));
|
||||
|
||||
# Remove any existing timers and trigger a new one
|
||||
foreach my $args (keys %intAt)
|
||||
{
|
||||
if (($intAt{$args}{ARG} eq $hash) && ($intAt{$args}{FN} eq 'MilightBridge_CmdQueue_Send'))
|
||||
{
|
||||
Log3 ($hash, 5, "$hash->{NAME}_CmdQueue_Send: Remove timer at: ".$intAt{$args}{TRIGGERTIME});
|
||||
delete($intAt{$args});
|
||||
}
|
||||
}
|
||||
InternalTimer(gettimeofday()+($hash->{INTERVAL}/1000), "MilightBridge_CmdQueue_Send", $hash, 0);
|
||||
}
|
||||
|
||||
return undef;
|
||||
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
=pod
|
||||
=begin html
|
||||
|
||||
<a name="MilightBridge"></a>
|
||||
<h3>MilightBridge</h3>
|
||||
<ul>
|
||||
<p>This module is the interface to a Milight Bridge which is connected to the network using a Wifi connection. It uses a UDP protocal with no acknowledgement so there is no guarantee that your command was received.</p>
|
||||
<p>The Milight system is sold under various brands around the world including "LimitlessLED, EasyBulb, AppLamp"</p>
|
||||
<p>The API documentation is available here: <a href="http://www.limitlessled.com/dev/">http://www.limitlessled.com/dev/</a></p>
|
||||
|
||||
<a name="MilightBridge_define"></a>
|
||||
<p><b>Define</b></p>
|
||||
<ul>
|
||||
<p><code>define <name> MilightBridge <host/ip></code></p>
|
||||
<p>Specifies the MilightBridge device.<br/>
|
||||
<host/ip> is the hostname or IP address of the Bridge.</p>
|
||||
</ul>
|
||||
<a name="MilightBridge_readings"></a>
|
||||
<p><b>Readings</b></p>
|
||||
<ul>
|
||||
<li>
|
||||
<b>state</b><br/>
|
||||
[ok|unreachable]: Set depending on result of a UDP ping sent every 10 seconds.
|
||||
</li>
|
||||
<li>
|
||||
<b>sendFail</b><br/>
|
||||
0 if everything is OK. 1 if the send function was unable to send the command - this would indicate a problem with your network and/or host/port parameters.
|
||||
</li>
|
||||
<li>
|
||||
<b>slot[0|1|2|3|4|5|6|7|8]</b><br/>
|
||||
The slotX reading will display the name of the <a href="#MilightDevice">MilightDevice</a> that is defined with this Bridge as it's <a href="#IODev">IODev</a>. It will be blank if no device is defined for that slot.
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MilightBridge_attr"></a>
|
||||
<p><b>Attributes</b></p>
|
||||
<ul>
|
||||
<li>
|
||||
<b>sendInterval</b><br/>
|
||||
Default: 100ms. The bridge has a minimum send delay of 100ms between commands.
|
||||
</li>
|
||||
<li>
|
||||
<b>port</b><br/>
|
||||
Default: 8899. Older bridges (V2) used port 50000 so change this value if you have an old bridge.
|
||||
</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
=end html
|
||||
=cut
|
||||
1785
fhem/FHEM/31_MilightDevice.pm
Normal file
1785
fhem/FHEM/31_MilightDevice.pm
Normal file
File diff suppressed because it is too large
Load Diff
@ -602,3 +602,7 @@
|
||||
- Wed Dec 17 2014 (Reinerlein)
|
||||
- added new module 00_SONOS and 21_SONOSPLAYER to support the Sonos Multiroom Audiosystem
|
||||
|
||||
- Mon Dec 22 2014 (mattwire)
|
||||
- added new module 30_MilightBridge and 31_MilightDevice to support Milight LED lights/strips/controllers.
|
||||
|
||||
|
||||
|
||||
@ -104,8 +104,10 @@ FHEM/23_WEBIO.pm sachag http://forum.fhem.de Sonstiges
|
||||
FHEM/23_WEBIO_12DIGITAL.pm sachag http://forum.fhem.de Sonstiges
|
||||
FHEM/24_NetIO230B.pm rudolfkoenig/orphan http://forum.fhem.de Sonstiges
|
||||
FHEM/30_HUEBridge.pm justme1968 http://forum.fhem.de Beleuchtung
|
||||
FHEM/30_MilightBridge.pm mattwire http://forum.fhem.de Beleuchtung
|
||||
FHEM/30_ENECSYSGW.pm akw http://forum.fhem.de Sonstige Systeme
|
||||
FHEM/31_HUEDevice.pm justme1968 http://forum.fhem.de Beleuchtung
|
||||
FHEM/31_MilightDevice.pm mattwire http://forum.fhem.de Beleuchtung
|
||||
FHEM/31_ENECSYSINV.pm akw http://forum.fhem.de Sonstige Systeme
|
||||
FHEM/31_LightScene.pm justme1968 http://forum.fhem.de Automatisierung
|
||||
FHEM/32_SYSSTAT.pm justme1968 http://forum.fhem.de Unterstuetzende Dienste
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user