mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 18:59:33 +00:00
187 lines
6.9 KiB
Perl
187 lines
6.9 KiB
Perl
##############################################
|
|
# $Id$
|
|
# from myUtilsTemplate.pm 21509 2020-03-25 11:20:51Z rudolfkoenig
|
|
# utils for valetudo v2 API MQTT Implementation
|
|
# They are then available in every Perl expression.
|
|
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
sub
|
|
valetudoUtils_Initialize {
|
|
my $hash = shift;
|
|
return;
|
|
}
|
|
# Enter you functions below _this_ line.
|
|
|
|
#######
|
|
# decode_json() croaks on error, this function should prevent fhem crashes
|
|
# https://metacpan.org/pod/Perl::Critic::Policy::ErrorHandling::RequireCheckingReturnValueOfEval
|
|
sub decode_j {
|
|
use JSON qw(decode_json);
|
|
my $maybe_json = shift;
|
|
my $data;
|
|
if ( eval { $data = decode_json($maybe_json); 1 } ) { return $data }
|
|
Log3(undef, 1, "JSON decoding error, >$maybe_json< seems not to be valid JSON data: $@");
|
|
return q{}
|
|
}
|
|
|
|
#######
|
|
# return a string for dynamic selection setList (widgets)
|
|
sub valetudo_w {
|
|
my $NAME = shift;
|
|
my $setter = shift;
|
|
# this part reads segments, it's only filled if Provide map data is enabled in connectivity
|
|
if ($setter eq 'segments') {
|
|
my $json = ReadingsVal($NAME,'.segments','{}');
|
|
if ($json eq '{}') {$json = '{"1":"no_Segment_or_not_supported"}'};
|
|
my $decoded = decode_j($json);
|
|
return join ',', sort values %{$decoded}
|
|
}
|
|
# this part read presets which contains a full json for preset zones or locations
|
|
if ($setter eq 'zones' or $setter eq 'locations') {
|
|
my $json = ReadingsVal($NAME,'.'.$setter.'Presets',q{});
|
|
my $decoded = decode_j($json);
|
|
my @array;
|
|
for ( keys %{$decoded} ) { push @array, $decoded->{$_}->{'name'} }
|
|
return join ',', sort @array
|
|
}
|
|
# this part is for study purpose to read the full json segments with the REST API like
|
|
# setreading alias=DreameL10pro json_segments {(qx(wget -qO - http://192.168.90.21/api/v2/robot/capabilities/MapSegmentationCapability))}
|
|
if ($setter eq 'json_segments') {
|
|
my $json = ReadingsVal($NAME,'json_segments','select');
|
|
my $decoded = decode_j($json);
|
|
my @array=@{$decoded};
|
|
my %t;
|
|
for (@array) { $t{$_->{'name'}} = $_->{'id'} }
|
|
return join ',', sort keys %t
|
|
}
|
|
}
|
|
#######
|
|
# valetudo_c return a complete string for setList right part
|
|
sub valetudo_c {
|
|
my $NAME = shift;
|
|
my ($cmd,$load) = split q{ }, shift, 2;
|
|
my $ret = 'error';
|
|
my $devicetopic = AttrVal($NAME,'devicetopic',"valetudo/$NAME");
|
|
|
|
# x_raw_payload like
|
|
# /MapSegmentationCapability/clean/set {"segment_ids":["6"],"iterations":1,"customOrder":true}
|
|
if ($cmd eq 'x_raw_payload') { $ret=$devicetopic.$load }
|
|
|
|
# this part return an array of segment id's according to selected Names from segments (simple json)
|
|
if ($cmd eq 'clean_segment') {
|
|
my @rooms = split ',', $load;
|
|
my $json = ReadingsVal($NAME,'.segments',q{});
|
|
my $decoded = decode_j($json);
|
|
my @ids;
|
|
for ( @rooms ) { push @ids, {reverse %{$decoded} }->{$_} }
|
|
my %Hcmd = ( clean_segment => {segment_ids => \@ids,iterations => 1,customOrder => 'true' } );
|
|
$ret = $devicetopic.'/MapSegmentationCapability/clean/set '.toJSON $Hcmd{$cmd}
|
|
}
|
|
|
|
# this part return the zone/location id according to the selected Name from presets (zones/locations) (more complex json)
|
|
if ($cmd eq 'clean_zone') {
|
|
my $json = ReadingsVal($NAME,'.zonesPresets',q{});
|
|
my $decoded = decode_j($json);
|
|
for (keys %{$decoded}) {
|
|
if ( $decoded->{$_}->{'name'} eq $load ) {$ret = $devicetopic.'/ZoneCleaningCapability/start/set '.$_ }
|
|
}
|
|
}
|
|
if ($cmd eq 'goto') {
|
|
my $json = ReadingsVal($NAME,'.locationsPresets',q{});
|
|
my $decoded = decode_j($json);
|
|
for (keys %{$decoded}) {
|
|
if ( $decoded->{$_}->{'name'} eq $load ) {$ret = $devicetopic.'/GoToLocationCapability/go/set '.$_ }
|
|
}
|
|
}
|
|
|
|
# this part is for study purpose to read the full json segments with the REST API
|
|
# this part return an array of segment id's according to selected Names from json_segments (complex json)
|
|
if ($cmd eq 'clean_segment_j') {
|
|
$cmd = 'clean_segment'; # only during Test
|
|
my @rooms = split ',', $load;
|
|
my $json = ReadingsVal($NAME,'json_segments',q{});
|
|
my $decoded = decode_j($json);
|
|
my @array=@{$decoded};
|
|
my %t;
|
|
for (@array) { $t{$_->{'name'}} = $_->{'id'} }
|
|
my @ids;
|
|
for ( @rooms ) {push @ids, $t{$_}}
|
|
my %Hcmd = ( clean_segment => {segment_ids => \@ids,iterations => 1,customOrder => 'true' } );
|
|
$ret = $devicetopic.'/MapSegmentationCapability/clean/set '.toJSON $Hcmd{$cmd}
|
|
}
|
|
return $ret
|
|
}
|
|
#######
|
|
# ask the robot via REST API for Featurelist and feature and return true false
|
|
sub valetudo_f {
|
|
my $NAME = shift; # Devicename of the robot
|
|
my $substr = shift; # requested Feature like GoToLocation or MapSegmentation
|
|
my $ip = ReadingsVal($NAME,'ip4',(split ',',ReadingsVal($NAME,'ips','error'))[0]);
|
|
my $string = GetHttpFile($ip, '/api/v2/robot/capabilities');
|
|
index($string, $substr) == -1 ? '0':'1';
|
|
}
|
|
#######
|
|
# add a line to multiline Attribute setList or regList
|
|
# CommandAttr_multiline( 'MQTT2_valetudo_xxx','setList',q( clean_segment:{"multiple-strict,".valetudo_w($name,"segments")} { valetudo_c($NAME,$EVENT) }) )
|
|
sub CommandAttr_multiline {
|
|
my $NAME = shift;
|
|
my $attr = shift;
|
|
my $item = shift;
|
|
if ($attr ne 'setList' and $attr ne 'readingList') {return 'use only for multiline attrib'}
|
|
my $val = AttrVal($NAME,$attr,'')."\n".$item;
|
|
CommandAttr(undef, "$NAME $attr $val");
|
|
}
|
|
|
|
1;
|
|
=pod
|
|
=item summary generic MQTT2 vacuum valetudo Device
|
|
=item summary_DE generische MQTT2 Staubsauger gerootet mit valetudo
|
|
=begin html
|
|
|
|
Subroutines for generic MQTT2 vacuum cleaner Devices rooted with valetudo.
|
|
<a id="MQTT2 valetudo"></a>
|
|
<h3>MQTT2 valetudoUtils</h3>
|
|
<ul>
|
|
subroutines<br>
|
|
<b>valetudo_w</b> return a string for dynamic selection setList<br>
|
|
<b>valetudo_c</b> return a complete string for setList right part of setList<br>
|
|
<br>
|
|
<a id="MQTT2_DEVICE-setList"></a>
|
|
<b>attr setList</b>
|
|
<ul>
|
|
<code>clean_segment:{"multiple-strict,".valetudo_w($name,"segments")} { valetudo_c($NAME,$EVENT) }</code>
|
|
<br><br>
|
|
To use dynamic setList. The $EVENT is parsed inside utils.<br>
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
=end html
|
|
=begin html_DE
|
|
|
|
Subroutines for generic MQTT2 vacuum cleaner Devices rooted with valetudo.
|
|
<a id="MQTT2 valetudo"></a>
|
|
<h3>MQTT2 valetudoUtils</h3>
|
|
<ul>
|
|
subroutines<br>
|
|
<b>valetudo_w</b> return a string for dynamic selection setList<br>
|
|
<b>valetudo_c</b> return a complete string for setList right part of setList<br>
|
|
<br>
|
|
<a id="MQTT2_DEVICE-setList"></a>
|
|
<b>attr setList</b>
|
|
<ul>
|
|
<code>clean_segment:{"multiple-strict,".valetudo_w($name,"segments")} { valetudo_c($NAME,$EVENT) }</code>
|
|
<br><br>
|
|
To use dynamic setList. The $EVENT is parsed inside utils.<br>
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
|
|
=end html_DE
|
|
=cut
|