diff --git a/fhem/CHANGED b/fhem/CHANGED index 83e069bed..e5a03b85f 100644 --- a/fhem/CHANGED +++ b/fhem/CHANGED @@ -1,5 +1,8 @@ # 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 + - redesign:36_Shelly.pm: Überarbeitung der HTTP-Kommunikation + zahlreiche Änderungen und Ergänzungen + siehe Forum ../Sonstige Systeme/Support-Thread Modul 36_Shelly.pm - feature: 31_HUEDevice.pm: added addlight and removelight command for groups - bufgix: 72_FRITZBOX: Fehler behoben bei FritzOS >= 6.69 und < 7.00 - feature: 76_SolarForecast: improve manual setting of pvCorrectionFactor_XX diff --git a/fhem/FHEM/36_Shelly.pm b/fhem/FHEM/36_Shelly.pm index a54a9609b..a7b3dea8c 100644 --- a/fhem/FHEM/36_Shelly.pm +++ b/fhem/FHEM/36_Shelly.pm @@ -36,18 +36,18 @@ # Bug Fix: update interval of GetStatus call # 5.04 Bug Fix: undefined values on restart # Energymeter activated -# 5.05 Bug Fix: Begin/End-Update in sub () +# 5.05 Bug Fix: Begin/End-Update in sub () # 5.06 Bug Fix: undefined value for ShellyPMmini and others # Change: Model of ShellyPMmini changed to shellypmmini -# 5.07 BugFix: shellyrgbw (white mode): set ... toggle +# 5.07 BugFix: shellyrgbw (white mode): set ... toggle # 5.08 Add: set ... ON and OFF to switch all channels of a multichannel device # Change: set default of MaxAge to 600 hrs # Change: remove attribute 'ShellyName', use 'set ... name' instead -# Bug Fix: misc. 'undefined value' +# Bug Fix: misc. 'undefined value' # internal Optimization of Shelly_Set() # 5.09 Bug Fix (dimmer-devices): set..pct will not turn on or off # Add (dimmer-devices): set..dim will turn on or off -# 5.10 Add (dimmer-devices): set..dimup / dimdown +# 5.10 Add (dimmer-devices): set..dimup / dimdown # Add (sensor-addon): temperatures # 5.11 internal reorganisation of status calls # internal optimization of webhook handling @@ -55,7 +55,7 @@ # Feature: ShellyPro3EM attribute Balancing # 5.12 Add Gen3 Mini devices (fw gen2 compatibility) # Add: Roller devices: use 'set ... pos' equivalent to 'pct' -# Add (dimmer-devices): set..dim-for-timer +# Add (dimmer-devices): set..dim-for-timer # Bug Fix: store newkeys in helper after init # 5.13 Bug Fix: handling of attr 'shellyuser' for gen2 devices # 5.14 Add: set ... reset to set counters to zero @@ -63,12 +63,43 @@ # 5.15 change cmdref to attr ... model # 5.16 Bug Fix: function of dimmer # 5.17 Add: Roller devices: 'set ... position' equivalent to 'pct' -# 5.18 Bug Fix: function of all Gen1 relay devices -# 5.19 change back: roller devices: use 'set ... pct' as command +# 5.18 Bug Fix: function of all Gen1 relay devices +# 5.19 change back: roller devices: use 'set ... pct' as command # 5.20 Bug Fix: suppress status calls for disabled devices # 5.21 Bug Fix: Shelly-dimmer: convert dim-command with brightness=0 to an off-command # Bug Fix: Shelly-dimmer, Shelly-bulb: slider for pct starts with 1 -# 5.21.1 Bug Fix: removed uninitialized $oldtimer +# 5.21.1 Bug Fix: $oldtimer removed +# 6.00 beta 1 Internal optimization HTTP-communication, use of timers, optimization of lights-devices procedure, minor bug fixes +# ShellyRGBW: using effects +# added: set extensions +# added: shellyplusUni / in work +# fix: do not loose timer on other commands or retriggering +# new devices: Shelly Plus 0-10V Dimmer, Shelly Pro Dimmer, Shelly Plus Uni +# Add: range extender +# Change: control of actions now by set commands; attribute webhook is only used to set the correspondending FHEMWEB-Device. +# Add: BLE.CloudRelay.List +# open issues: shellypro3em not running properly +# 6.00 Beta_2 ShellyPro3EM: reading 'errors' changed to 'error_EM', interval for power values setable separately, fixed total reactive power +# removed reading 'timestamp' +# increase interval in case of network error, reset when reconnected +# added: commands 'set config ap_enable|ap_disable' to change access point of Gen2 devices +# reading 'state' is set to 'disabled' when interval is set to 0 +# reading 'network_threshold' moved to 'network_wifi_roaming', may be set to 'disabled' +# internal 'SHELLY' moved to reading 'model_ID'; according new readings model_family, model_function, model_name +# new gen3 models +# added: reading 'energy_returned' & 'energy_purchased' for Plus&Pro devices with PM +# changed: reading 'firmware' with hint 'check internet' when device seems not to have internet connection +# 6.00 Beta_3 fix: dimmable devices: command allowed 'set pct 0' to switch off the device +# added: humidity, input and voltmeter to Shelly Plus Addon; +# changed:readings name of analog input of Shelly Plus Uni will be renamed +# added: definition of the device by DNS-name instead of ip-address, new reading 'network_ip-address' with the ip-address of the device +# Pro devices only: separate readings, indexed by 'LAN' resp. 'Wifi' +# added: new reading 'ap_clients__model' with the model of the connected Shelly device (when connection via range extender is established) +# changed: command 'set reset ' changed to 'set ... clear ...' +# added: readings timer... are supported for shelly4pro (gen1) +# 6.00 Beta_4 add: client without definition --> reading 'no definition' +# new: attr timeout controls write out readings with response times +# 6.00 fix some details in commandref (german only) package main; @@ -76,21 +107,511 @@ package main; use strict; use warnings; -use JSON; +use JSON; use HttpUtils; +use SetExtensions; use vars qw{%attr %defs}; -use SetExtensions; sub Log($$); sub Shelly_Set ($@); #-- globals on start -my $version = "5.21.1 22.03.2024"; +my $version = "6.00 15.08.2024"; my $defaultINTERVAL = 60; -my $secndIntervalMulti = 4; # Multiplier for 'long update' +my $multiplyIntervalOnError = 1.0; # mechanism disabled if value=1 + +my %shelly_firmware = ( # latest known versions # as of 14.08.2024 + "gen1" => "v1.14.0", + "shelly4" => "v1.6.6", + "gen2" => "v1.4.0", + "walldisplay" => "v2.1.0" + ); + + +#-- Time slices in seconds for time zone Germany CET/CEST +# [offset dst==0, offset dst==1, periode length] +my %periods = ( + "min" => [0,0,60], + "hourT" => [0,0,300], # twelth of an hour (5 minutes) + "hourQ" => [0,0,900], # quarter of an hour + "hour" => [0,0,3600], + "dayQ" => [3600,7200,21600], # day quarter + "dayT" => [10800,14400,28800], # day third = 3x8h: 06:00 - 14:00 - 22:00 + "day" => [3600,7200,86400], + "Week" => [-342000,-338400,604800] # offset=-4x24x3600 + 3600 + $isdst x 3600 +); + +my %attributes = ( + "multichannel" => " defchannel", + "roller" => " pct100:open,closed maxtime maxtime_close maxtime_open", + "dimmer" => " dimstep", + "input" => " showinputs:show,hide", + "emeter" => " Energymeter_F Energymeter_P Energymeter_R EMchannels:ABC_,L123_,_ABC,_L123". + " Periods:multiple-strict,Week,day,dayT,dayQ,hour,hourQ,hourT,min". # @keys = keys %periods + " PeriodsCorr-F Balancing:0,1 interval_power", + "metering" => " maxpower", + "showunits" => " showunits:none,original,normal,normal2,ISO" +); + +my %shelly_dropdowns = ( +#-- these we may get on request + "Gets" => "status:noArg settings:noArg registers:noArg config version:noArg model:noArg actions:noArg", +#-- these we may set + "Shelly"=> "config interval password reboot:noArg update:noArg name reset:noArg clear:disconnects,error,energy,responsetimes", ##reset is deprecated ; CLR + "Actions"=>" actions", # create,delete,disable,enable,update + "Onoff" => " on off toggle on-for-timer off-for-timer",## on-till off-till on-till-overnight off-till-overnight blink intervals", + "Multi" => " ON:noArg OFF:noArg xtrachannels:noArg", + "Rol" => " closed open stop:noArg pct:slider,0,1,100 delta zero:noArg predefAttr:noArg", + "RgbwW" => " pct:slider,1,1,100 dim dimup dimdown dim-for-timer", ## later we add calibrate for shellydimmer + "BulbW" => " ct:colorpicker,CT,3000,10,6500 pct:slider,1,1,100", + "RgbwC" => " rgbw rgb:colorpicker,HSV hsv white:slider,0,1,100 gain:slider,0,1,100 effect:select,Off,1,2,3", + "Input" => " input:momentary,toggle,edge,detached,action" #momentary_on_release >>Shelly1 +); +## may be used for RgbwC: +## "hsv:colorpicker,HSV" +## "rgb:colorpicker,RGB" +## "white:colorpicker,BRI,0,1,255" + +# Device model by https://kb.shelly.cloud/knowledge-base/ +# Device name as given by KB listed as comment +my %shelly_vendor_ids = ( + # Gen1 devices + "SHSW-1" => ["shelly1", "Shelly 1"], ## no power metering + "SHSW-PM" => ["shelly1pm", "Shelly 1PM"], + "SHSW-L" => ["shelly1L", "Shelly 1L"], ## with AC power metering + "SHSW-21" => ["shelly2", "Shelly 2"], ## not listed in KB + "SHSW-25" => ["shelly2.5", "Shelly 2.5"], + "SHSW-44" => ["shelly4", "Shelly 4 Pro"], ## not listed in KB + "SHIX3-1" => ["shellyi3", "Shelly i3"], + "SHEM" => ["shellyem", "Shelly EM"], + "SHEM-3" => ["shelly3em", "Shelly 3EM"], + "SHUNI-1" => ["shellyuni", "Shelly Uni"], + "SHSTRV-01" => ["generic", "Shelly TRV"], + "SHBTN-1" => ["generic", "Shelly Button 1"], + "SHBTN-2" => ["generic", "Shelly Button 2"], ## not listed in KB + "SHPLG2-1" => ["shellyplug", "Shelly Plug"], + "SHPLG-S" => ["shellyplug", "Shelly Plug S"], + "SHPLG-US" => ["shellyplug", "Shelly Plug US"], ## check device model >SHPLG-US< + "SHRGBW2" => ["shellyrgbw", "Shelly RGBW2"], + "SHDM-1" => ["shellydimmer", "Shelly Dimmer 1"], ## not listed in KB + "SHDM-2" => ["shellydimmer", "Shelly Dimmer 2"], + + "SHBDUO-1" => ["shellybulb", "Shelly Duo/Duo GU10"], ## dimmable white (WW/CW) light with submodels: E27 or GU10 fitting + "SHVIN-1" => ["shellybulb", "Shelly Vintage"], ## dimmable white light with different fittings + "SHBLB-1" => ["shellybulb", "Shelly Bulb"], # + "SHCB-1" => ["shellybulb", "Shelly duo color G10"], # = shelly color bulb + + "SHHT-1" => ["generic", "Shelly H&T"], ## humidity and temperature sensor + "SHWT-1" => ["generic", "Shelly Flood"], ## flood sensor + "SHDW-1" => ["generic", "Shelly Door/Window"], ## not listed in KB + "SHDW-2" => ["generic", "Shelly Door/Window 2"], + "SHGS-1" => ["generic", "Shelly Gas"], ## gas sensor + "SHSM-1" => ["generic", "Shelly Smoke"], ## smoke sensor ## not listed in KB + "SHMOS-01" => ["generic", "Shelly Motion"], ## motion sensor + "SHMOS-02" => ["generic", "Shelly Motion 2"], ## motion sensor 2 + "SHSEN-1" => ["generic", "Shelly motion & ir-controller"], ## not listed in KB + # Plus devices ## 2nd Gen + "SNSW-001X16EU" => ["shellyplus1", "Shelly Plus 1"], + "SNSW-001P16EU" => ["shellyplus1pm", "Shelly Plus 1PM"], + "SNSW-001P15UL" => ["shellyplus1pm", "Shelly Plus 1PM UL"], ## new + "SNSW-002P16EU" => ["shellyplus2pm", "Shelly Plus 2PM"], + "SNSW-102P16EU" => ["shellyplus2pm", "Shelly Plus 2PM"], ## 102 ?? not more listed in KB + "SNSW-002P15UL" => ["shellyplus2pm", "Shelly Plus 2PM UL"], ## new + "SNSN-0024X" => ["shellyplusi4", "Shelly Plus i4"], ## AC operated + "SNSN-0D24X" => ["shellyplusi4", "Shelly Plus i4DC"], + "SNSN-0013A" => ["generic", "Shelly Plus H&T"], ## temp&humidity sensor + "SNPL-00110IT" => ["shellyplusplug", "Shelly Plus Plug IT"], ## italian style + "SNPL-00112EU" => ["shellyplusplug", "Shelly Plus Plug S V1"], ## german style + "SNPL-10112EU" => ["shellyplusplug", "Shelly Plus Plug S V2"], ## german style V2 + "SNPL-00112UK" => ["shellyplusplug", "Shelly Plus Plug UK"], ## UK style + "SNPL-00116US" => ["shellyplusplug", "Shelly Plus Plug US"], ## US style + "SNSN-0031Z" => ["generic", "Shelly Plus Smoke"], + "SNDM-0013US" => ["generic", "Shelly Plus Wall Dimmer"], ## + "SNSN-0043X" => ["shellyplusuni", "Shelly Plus Uni"], + "SNDM-00100WW" => ["shellyplus010v", "Shelly Plus 0-10V Dimmer"], + "SNDC-0D4P10WW" => ["shellyplusrgbwpm", "Shelly Plus RGBW PM"], ##new + ## Mini Devices + "SNSW-001X8EU" => ["shellyplus1", "Shelly Plus 1 Mini"], + "SNSW-001P8EU" => ["shellyplus1pm", "Shelly Plus 1PM Mini"], + "SNPM-001PCEU16" => ["shellypmmini", "Shelly Plus PM Mini"], + # Gen3 Devices + "S3SW-001X16EU" => ["shellyplus1", "Shelly 1 Gen3"], ##new + "S3SW-001P16EU" => ["shellyplus1pm", "Shelly 1PM Gen3"], ##new + "S3SN-0024X" => ["shellyi4gen3", "Shelly i4 Gen3"], ## (AC), new + "S3SN-0U12A" => ["generic", "Shelly H&T Gen3"], ## new, not yet implemented + "S3DM-0010WW" => ["shellyplus010v", "Shelly Dimmer 0/1-10V PM Gen3"], ## new + ## Mini Gen3 Devices + "S3SW-001X8EU" => ["shellyplus1", "Shelly 1 Mini Gen3"], + "S3SW-001P8EU" => ["shellyplus1pm", "Shelly 1 PM Mini Gen3"], + "S3PM-001PCEU16" => ["shellypmmini", "Shelly PM Mini Gen3"], + # 2nd Gen PRO devices + "SPSW-001XE16EU" => ["shellypro1", "Shelly Pro 1"], ## not listed by KB + "SPSW-201XE16EU" => ["shellypro1", "Shelly Pro 1 v.1"], + "SPSW-001PE16EU" => ["shellypro1pm", "Shelly Pro 1PM"], ## not listed by KB + "SPSW-201PE16EU" => ["shellypro1pm", "Shelly Pro 1PM v.1"], + "SPSW-002XE16EU" => ["shellypro2", "Shelly Pro 2"], ## not listed by KB + "SPSW-202XE16EU" => ["shellypro2", "Shelly Pro 2 v.1"], + "SPSW-002PE16EU" => ["shellypro2pm", "Shelly Pro 2PM"], ## not listed by KB + "SPSW-202PE16EU" => ["shellypro2pm", "Shelly Pro 2PM v.1"], + "SPSH-002PE16EU" => ["shellyprodual", "Shelly Pro Dual Cover/Shutter PM"], + "SPDM-001PE01EU" => ["shellyprodm1pm", "Shelly Pro Dimmer 1PM"], ##new + "SPDM-002PE01EU" => ["shellyprodm2pm", "Shelly Pro Dimmer 2PM"], + "SPSW-003XE16EU" => ["shellypro3", "Shelly Pro 3"], + "SPEM-003CEBEU" => ["shellypro3em", "Shelly Pro 3EM"], + "SPEM-003CEBEU400"=> ["shellypro3em", "Shelly Pro 3EM-400"], + "SPEM-002CEBEU50" => ["shellyproem50", "Shelly Pro EM-50"], + "SPSW-004PE16EU" => ["shellypro4pm", "Shelly Pro 4PM V1"], + "SPSW-104PE16EU" => ["shellypro4pm", "Shelly Pro 4PM V2"], + # Control Panels + "SAWD-0A1XX10EU1" => ["walldisplay1", "Shelly Wall Display"], ## prelim version ? ## not listed by KB + "SAWD1" => ["walldisplay1", "Shelly Wall Display"] + ); + +my %shelly_family = ( + # family code as given in first two characters of family-id + "SH" => "Gen1", + "SN" => "Plus/Gen2", + "DC" => "LED driverGen3", + "SP" => "Pro/Gen2", + "SA" => "Control Panel" + ); + +my %shelly_category = ( + # code as given in characters 3 & 4 of family-id (not for Gen1-devices) + "DC" => "LED driver", + "DM" => "dimmer", + "EM" => "energy meter", + "PL" => "plug", + "PM" => "power meter", + "SN" => "sensor", + "SW" => "switch", + "WD" => "wall display" + ); + + +my %shelly_models = ( + #( 0 1 2 3 4 5 6 7 8) + #(relays,rollers,dimmers, meters, NG,inputs, res.,color,modes) + "generic" => [0,0,0, 0,0,0, 0,0,0], + "shellyi3" => [0,0,0, 0,0,3, 0,0,0], # 3 inputs + "shelly1" => [1,0,0, 0,0,1, 0,0,0], # not metering, only a power constant in older fw + "shelly1L" => [1,0,0, 1,0,1, 0,0,0], + "shelly1pm" => [1,0,0, 1,0,1, 0,0,0], + "shelly2" => [2,1,0, 1,0,2, 0,0,2], # relay mode, roller mode + "shelly2.5" => [2,1,0, 2,0,2, 0,0,2], # relay mode, roller mode + "shellyplug" => [1,0,0, 1,0,-1, 0,0,0], # shellyplug & shellyplugS; no input, but a button which is only reachable via Action + "shelly4" => [4,0,0, 4,0,4, 0,0,0], # shelly4pro; inputs not provided by fw v1.6.6 + "shellyrgbw" => [0,0,4, 4,0,1, 0,1,2], # shellyrgbw2: color mode, white mode; metering col 1 channel, white 4 channels + "shellydimmer" => [0,0,1, 1,0,2, 0,0,0], + "shellyem" => [1,0,0, 2,0,0, 0,0,0], # with one control-relay, consumed energy in Wh + "shelly3em" => [1,0,0, 3,0,0, 0,0,0], # with one control-relay, consumed energy in Wh + "shellybulb" => [0,0,1, 1,0,0, 0,1,2], # shellybulb & shellybulbrgbw: color mode, white mode; metering is in any case 1 channel + "shellyuni" => [2,0,0, 0,0,2, 0,0,0], # + analog dc voltage metering + #-- 2nd generation devices + "shellyplusplug"=> [1,0,0, 1,1,0, 0,0,0], # has a button, that is NOT reachable via action + "shellypluspm" => [0,0,0, 1,1,0, 0,0,0], + "shellyplus1" => [1,0,0, 0,1,1, 0,0,0], + "shellyplus1pm" => [1,0,0, 1,1,1, 0,0,0], + "shellyplus2pm" => [2,1,0, 2,2,2, 0,0,2], # switch profile, cover profile + "shellyplusuni" => [2,0,0, 0,1,2, 0,0,0], ### entwurf wie shellypro2; 1 xtra input as counter + "shellyplus010v"=> [0,0,1, 0,2,2, 0,0,0], # one instance of light, 0-10V output + "shellyplusi4" => [0,0,0, 0,1,4, 0,0,0], + "shellyplusrgbwpm"=>[0,0,4,4,2,4, 0,1,2], + "shellypro1" => [1,0,0, 0,1,2, 0,0,0], + "shellypro1pm" => [1,0,0, 1,1,2, 0,0,0], + "shellypro2" => [2,0,0, 0,1,2, 0,0,0], + "shellypro2pm" => [2,1,0, 2,1,2, 0,0,2], # switch profile, cover profile + "shellypro3" => [3,0,0, 0,1,3, 0,0,0], # 3 potential free contacts + "shellypro4pm" => [4,0,0, 4,1,4, 0,0,0], + "shellyprodm1pm"=> [0,0,1, 1,2,2, 0,0,0], # 1 dimmer with 2 inputs + "shellyprodm2pm"=> [0,0,2, 2,2,4, 0,0,0], # 2 dimmer with each 2 inputs + "shellyproem50" => [1,0,0, 1,1,0, 0,0,0], # has two single-phase meter and one relay + "shellypro3em" => [0,0,0, 1,1,0, 0,0,0], # has one (1) three-phase meter + "shellyprodual" => [0,2,0, 4,1,4, 0,0,0], + "shellypmmini" => [0,0,0, 1,1,0, 0,0,0], # similar to ShellyPlusPM + "walldisplay1" => [1,0,0, 0,2,1, 0,0,0] # similar to ShellyPlus1PM + #-- 3rd generation devices (not covered by plus or pro devices) + ); + +my %shelly_events = ( # events, that can be used by webhooks; key is mode, value is shelly-event + #Gen1 devices + "generic" => [""], + "shellyi3" => ["btn_on_url","btn_off_url","shortpush_url","longpush_url", + "double_shortpush_url","triple_shortpush_url","shortpush_longpush_url","longpush_shortpush_url"], + "shelly1" => ["btn_on_url","btn_off_url","longpush_url","shortpush_url","out_on_url","out_off_url"], + "shelly1L" => ["btn1_on_url","btn1_off_url","btn1_longpush_url","btn1_shortpush_url", + "btn2_on_url","btn2_off_url","btn2_longpush_url","btn2_shortpush_url","out_on_url","out_off_url"], + "shelly1pm" => ["btn_on_url","btn_off_url","out_on_url","out_off_url","longpush_url","shortpush_url","lp_on_url","lp_off_url"], + "shelly2" => ["btn_on_url","btn_off_url","longpush_url","shortpush_url","out_on_url","out_off_url", + "roller_open_url","roller_close_url","roller_stop_url"], + "shelly2.5" => ["btn_on_url","btn_off_url","longpush_url","shortpush_url","out_on_url","out_off_url", + "roller_open_url","roller_close_url","roller_stop_url"], + "shellyplug" => ["btn_on_url","out_on_url","out_off_url"], + "shelly4" => [""], + "shellyrgbw" => ["btn_on_url","btn_off_url","longpush_url","shortpush_url","out_on_url","out_off_url"], + "shellydimmer" => ["btn1_on_url","btn1_off_url","btn1_longpush_url","btn1_shortpush_url", + "btn2_on_url","btn2_off_url","btn2_longpush_url","btn2_shortpush_url","out_on_url","out_off_url"], + "shellyem" => ["out_on_url","out_off_url","over_power_url","under_power_url"], + "shelly3em" => ["out_on_url","out_off_url","over_power_url","under_power_url"], + "shellybulb" => ["out_on_url","out_off_url"], + "shellyuni" => ["btn_on_url","btn_off_url","longpush_url","shortpush_url","out_on_url","out_off_url","adc_over_url","adc_under_url"], + "addon1" => ["report_url","ext_temp_over_url","ext_temp_under_url","ext_hum_over_url","ext_hum_under_url"], + #Gen2 components; event given as key 'event' by rpc/Webhook.List + "light" => ["light.on", "light.off"], # events of the light component + "relay" => ["switch.on", "switch.off"], # events of the switch component + "roller" => ["cover.stopped","cover.opening","cover.closing","cover.open","cover.closed"], + "switch" => ["input.toggle_on","input.toggle_off"], # for input instances of type switch + "button" => ["input.button_push","input.button_longpush","input.button_doublepush","input.button_triplepush"], # for input instances of type button + "emeter" => ["em.active_power_change","em.voltage_change","em.current_change"], + "pm1" => ["pm1.apower_change","pm1.voltage_change","pm1.current_change"], + "touch" => ["input.touch_swipe_up","input.touch_swipe_down","input.touch_multi_touch"], + "sensor" => ["temperature.change","humidity.change","illuminance.change"], + "addon" => ["temperature.change"] +); + +my %fhem_events = ( # events, that can be used by webhooks; key is shelly-event, value is event sent to Fhem + #Gen 1 + "out_on_url" => "out_on", + "out_off_url" => "out_off", + "roller_stopp_url" => "stopped", + "roller_open_url" => "stopped", + "roller_close_url" => "stopped", + "btn_on_url" => "button_on", + "btn_off_url" => "button_off", + "lp_on_url" => "", # Shelly1pm: button long pressed + "lp_off_url" => "", + "shortpush_url" => "single_push", + "longpush_url" => "long_push", + "double_shortpush_url" => "double_push", + "triple_shortpush_url" => "triple_push", + "shortpush_longpush_url" => "short_long_push", + "longpush_shortpush_url" => "long_short_push", + "adc_over_url" => "", + "adc_under_url" => "", + "report_url" => "", + "ext_temp_over_url" => "", + "ext_temp_under_url" => "", + "ext_hum_over_url" => "", + "ext_hum_under_url" => "", + #Shelly dimmer + "btn1_on_url" => "button_on 0", + "btn1_off_url" => "button_off 0", + "btn1_shortpush_url" => "single_push 0", + "btn1_longpush_url" => "long_push 0", + "btn2_on_url" => "button_on 1", + "btn2_off_url" => "button_off 1", + "btn2_shortpush_url" => "single_push 1", + "btn2_longpush_url" => "long_push 1", + + #Gen 2 + #light + "light.on" => "out_on", + "light.off" => "out_off", + #relay + "switch.on" => "out_on", + "switch.off" => "out_off", + #roller + "cover.stopped" => "stopped", + "cover.opening" => "opening", + "cover.closing" => "closing", + "cover.open" => "is_open", + "cover.closed" => "is_closed", + #switch + "input.toggle_on" => "button_on", + "input.toggle_off" => "button_off", + #button + "input.button_push" => "single_push", + "input.button_longpush" => "long_push", + "input.button_doublepush" => "double_push", + "input.button_triplepush" => "triple_push", + #touch + "input.touch_swipe_up" => "touch_up", + "input.touch_swipe_down" => "touch_down", + "input.touch_multi_touch" => "touch_multi", + #emeter (multiphase) + "em.active_power_change" => 'Active_Power_${phase} ${ev.act_power}', + "em.voltage_change" => 'Voltage_${phase} ${ev.voltage}', + "em.current_change" => 'Current_${phase} ${ev.current}', + #mini-emeter (shellypmmini) + "pm1.apower_change" => 'power ${ev.apower}', + "pm1.voltage_change" => 'voltage ${ev.voltage}', + "pm1.current_change" => 'current ${ev.current}', + #addon and wall display sensor + "temperature.measurement" => "tempC", + "temperature.change" => 'tempC ${ev.tC}', + "humidity.change" => 'humidity ${ev.rh}', + "illuminance.change" => 'illuminance ${ev.illumination}', + # translations + "S" => "single_push", + "L" => "long_push", + "SS" => "double_push", + "SSS" => "triple_push", + "SL" => "short_long_push", + "LS" => "long_short_push", + "short_push" => "S", + "single_push" => "S", + "long_push" => "L", + "double_push" => "SS", + "triple_push" => "SSS" +); + + +my %shelly_regs = ( + "relay" => "reset=1\x{27f6}factory reset\n". + "appliance_type=<string>\x{27f6}custom configurabel appliance type\n". # uni + "has_timer=0|1\x{27f6}wheather there is an active timer on the channel \n". # uni + "overpower=0|1\x{27f6}wheather an overpower condition has occured \n". # uni !Sh1 1pm 4pro plug + "default_state=off|on|last|switch\x{27f6}state after power on\n". + "btn_type=momentary|toggle|edge|detached|action|cycle|momentary_on_release\x{27f6}type of local button\n". # extends for uni *1L + "btn_reverse=0|1\x{27f6}invert local button\n". # *1L Sh1L has two buttons + "auto_on=<seconds>\x{27f6}timed on\n". + "auto_off=<seconds>\x{27f6}timed off\n". + "schedule=0|1\x{27f6}enable schedule timer\n". + "max_power=<watt>\x{27f6}power threshold above which an overpower condition will be triggered", # sh1pm sh1L !sh2 2.5 4pro plug + "roller" => "reset=1\x{27f6}factory reset\n". + "maxtime=<seconds>\x{27f6}maximum time needed to completely open or close\n". + "maxtime_open=<seconds>\x{27f6}maximum time needed to completely open\n". + "maxtime_close=<seconds>\x{27f6}maximum time needed to completely close\n". + "default_state=stop|open|close|switch\x{27f6}state after power on\n". + "swap=true|false\x{27f6}swap open and close directions\n". + "swap_inputs=true|false\x{27f6}swap inputs\n". + "input_mode=openclose|onebutton\x{27f6}two or one local button\n". + "button_type=momentary|toggle|detached|action\x{27f6}type of local button\n". # frmly btn_type + "btn_reverse=true|false\x{27f6}whether to invert the state of input switch\n". + "state=stop|open|close\x{27f6}state of roller\n". + "power=<watt>\x{27f6}current power consumption\n". + "safety_switch=true|false\x{27f6}whether the safety input is currently triggered\n". + "schedule=true|false\x{27f6}whether scheduling is enabled\n". + "obstacle_mode=disabled|while_opening|while_closing|while_moving\x{27f6}when to react on obstacles\n". + "obstacle_action=stop|reverse\x{27f6}what to do\n". + "obstacle_power=<watt>\x{27f6}power threshold for detection\n". + "obstacle_delay=<seconds>\x{27f6}delay after motor start to watch\n". + "safety_mode=disabled|while_opening|while_closing|while_moving\x{27f6}safety mode=2nd button\n". + "safety_action=stop|pause|reverse\x{27f6}action when safety mode\n". + "safety_allowed_on_trigger=none|open|close|all\x{27f6}commands allowed in safety mode\n". + "off_power=<watt>\x{27f6}power value below the roller is considered \'stopped\'\n". + "positioning=true|false\x{27f6}whether the device is calibrated for positioning control", + "color" => "reset=1\x{27f6}factory reset\n". # shellyrgbw2 color-mode: /settings/color/0 || /settings/light/0 + # "coiot=0|1\x{27f6}enable coiot\n". + "name=<name>\x{27f6}channel name\n". + "transition=<milliseconds>\x{27f6}transition time between on and off, 0...5000\n". + "effect=0|1|2|3\x{27f6}apply an effect 1=Meteor Shower 2=Gradual Change 3=Flash\n". # !|4|5|6 + "default_state=off|on|last\x{27f6}state after power on\n". + "btn_type=momentary|toggle|edge|detached\x{27f6}type of local button\n". + "btn_reverse=0|1\x{27f6}invert local button\n". + "auto_on=<seconds>\x{27f6}timed on\n". + "auto_off=<seconds>\x{27f6}timed off\n". + "schedule=0|1\x{27f6}enable schedule timer\n". + "btn_type=momentary|toggle|edge|detached|action\x{27f6}type of local button\n". + "btn_reverse=0|1\x{27f6}invert local button", + "bulbw" => "reset=1\x{27f6}factory reset\n". # shellyrgbw2 white-mode: /settings/white/{index} || /settings/light/{index} bulb white:/settings/light/0 + "brightness=<number>\x{27f6}output level 0...100\n". + "transition=<milliseconds>\x{27f6}transition time between on and off, 0...5000\n". + "default_state=off|on|last\x{27f6}state after power on\n". # !switch + "auto_on=<seconds>\x{27f6}timer to turn ON after every OFF command\n". + "auto_off=<seconds>\x{27f6}timer to turn OFF after every ON command\n". + "schedule=0|1\x{27f6}enable schedule timer", + "white" => "name=<name>\x{27f6}channel name\n". # additional registers for rgbw-white + "btn_type=momentary|toggle|edge|detached\x{27f6}type of local button\n". + "btn_reverse=0|1\x{27f6}invert local button\n". + "out_on_url=<url>\x{27f6}url when output is activated\n". + "out_off_url=<url>\x{27f6}url when output is deactivated", + "light" => "reset=1\x{27f6}factory reset\n". # shellydimmer /settings/light/0 + # "reset=0|1\x{27f6}whether factory reset via 5-time flip of the input switch is enabled\n". + # "name=<name>\x{27f6}dimmer device name\n". # does not work properly + "default_state=off|on|last|switch\x{27f6}state after power on\n". + "auto_on=<seconds>\x{27f6}timer to turn the dimmer ON after every OFF command\n". + "auto_off=<seconds>\x{27f6}timer to turn the dimmer OFF after every ON command\n". + "btn_type=one_button|dual_button|toggle|edge|detached|action\x{27f6}type of local button\n". + "btn_debounce=<milli seconds>\x{27f6}button debounce time (60...200ms)\n". + "swap_inputs=0|1\x{27f6}swap inputs", + "input" => "reset=1\x{27f6}factory reset\n". + "name=<name>\x{27f6}input name\n". + "btn_type=momentary|toggle\x{27f6}type of local button\n". + "btn_reverse=0|1\x{27f6}invert local button\n" + ); + +my %predefAttrs = ( + "roller_webCmd" => "open:up:down:closed:half:stop:pct", + "roller_eventMap_closed100" => "/delta -15:up/delta +15:down/pos 50:half/", + "roller_eventMap_open100" => "/delta +15:up/delta -15:down/pos 50:half/", + "roller_cmdIcon" => "open:control_arrow_upward\@blue up:control_arrow_up\@blue down:control_arrow_down\@blue closed:control_arrow_downward\@blue". + " stop:rc_STOP\@blue half:fts_shutter_50\@blue", + "roller_open100" => "open:fts_shutter_100:closed". + " closed:fts_shutter_10:open". + " half:fts_shutter_50:closed". + " drive-up:fts_shutter_up\@red:stop". + " drive-down:fts_shutter_down\@red:stop". + " pct-100:fts_window_2w:closed". + " pct-90:fts_shutter_10:closed". + " pct-80:fts_shutter_20:closed". + " pct-70:fts_shutter_30:closed". + " pct-60:fts_shutter_40:closed". + " pct-50:fts_shutter_50:closed". + " pct-40:fts_shutter_60:open". + " pct-30:fts_shutter_70:open". + " pct-20:fts_shutter_80:open". + " pct-10:fts_shutter_90:open". + " pct-0:fts_shutter_100:open", + "roller_closed100" => "open:fts_shutter_10:closed". + " closed:fts_shutter_100:open". + " half:fts_shutter_50:closed". + " drive-up:fts_shutter_up\@red:stop". + " drive-down:fts_shutter_down\@red:stop". + " pct-100:fts_shutter_100:open". + " pct-90:fts_shutter_90:closed". + " pct-80:fts_shutter_80:closed". + " pct-70:fts_shutter_70:closed". + " pct-60:fts_shutter_60:closed". + " pct-50:fts_shutter_50:closed". + " pct-40:fts_shutter_40:open". + " pct-30:fts_shutter_30:open". + " pct-20:fts_shutter_20:open". + " pct-10:fts_shutter_10:open". + " pct-0:fts_window_2w:closed" + ); + +my %si_units = ( + "time" => [""," sec"], + "time_ms" => [""," ms"], # Milli-Seconds + "current" => [""," A"], + "voltage" => [""," V"], + "voltmeter" => [""," V"], # same as voltage, used by Shelly Sensor Addon + "power" => [""," W"], # Wirkleistung + "reactivepower" => [""," var"], # Blindleistung + "apparentpower" => [""," VA"], # Scheinleistung + "energy" => [""," Wh"], # Arbeit; + "frequency" => [""," Hz"], + "tempC" => [""," °C"], # Celsius + "temperature" => [""," °C"], # Celsius + "humidity" => [""," %"], + "pct" => [""," %"], + "illuminance" => [""," lx"], # Lux; illuminance eg WallDisplay + "illumination" => ["",""], # values: twilight, ... dark,... + "ct" => [""," K"], # color temperature / Kelvin + "rssi" => [""," dBm"], # deziBel Miniwatt + "input" => ["",""] # dummy - used by Shelly Sensor Addon + ); + + my %energy_units = ( #si, faktor, decimals + "none" => [ "Wh", 1, 0 ], + "normal" => [ "Wh", 1, 1 ], + "normal2" => [ "kWh",0.001, 4 ], + "ISO" => [ "kJ", 3.6, 0 ] + ); + +my %peripherals = ( + # Peripheral type => Component Type + "analog_in" => "input", + "digital_in" => "input", + "dht22" => "humidity", + "ds18b20" => "temperature", + "voltmeter" => "voltmeter" +); + #-- support differtent readings-names for energy & power metering my %mapping = ( @@ -194,7 +715,7 @@ my %mapping = ( 'frequency' => "Frequency", # Frequenz 'cap' => "capacitive", # kapazitiv 'ind' => "inductive", # induktiv - 'total_act_energy' => "Purchased_Energy", # Wirkenergie_Bezug + 'total_act_energy' => "Purchased_Energy", # Wirkenergie_Bezug 'total_act_ret_energy' => "Returned_Energy", # Wirkenergie_Einspeisung 'act' => "Purchased_Energy", 'act_ret' => "Returned_Energy", @@ -206,425 +727,9 @@ my %mapping = ( 'meter' => "Meter", 'meter2' => "Meter2" } -); - -#-- Time slices in seconds for time zone Germany CET/CEST -# [offset dst==0, offset dst==1, periode length] -my %periods = ( - "min" => [0,0,60], - "hourQ" => [0,0,900], # quarter of an hour - "hour" => [0,0,3600], - "dayQ" => [3600,7200,21600], # day quarter - "dayT" => [10800,14400,28800], # day third = 3x8h: 06:00 - 14:00 - 22:00 - "day" => [3600,7200,86400], - "Week" => [-342000,-338400,604800] # offset=-4x24x3600 + 3600 + $isdst x 3600 -); - -my %attributes = ( - "multichannel" => " defchannel", - "roller" => " pct100:open,closed maxtime maxtime_close maxtime_open", - "dimmer" => " dimstep", - "input" => " showinputs:show,hide", - "emeter" => " Energymeter_F Energymeter_P Energymeter_R EMchannels:ABC_,L123_,_ABC,_L123". - " Periods:multiple-strict,Week,day,dayT,dayQ,hour,hourQ,min". # @keys = keys %periods - " PeriodsCorr-F Balancing:0,1", - "metering" => " maxpower", - "showunits" => " showunits:none,original,normal,normal2,ISO" -); - -my %shelly_dropdowns = ( -#-- these we may get on request - "Gets" => "status:noArg shelly_status:noArg registers:noArg config version:noArg model:noArg", -#-- these we may set - "Shelly"=> "config interval password reboot:noArg update:noArg name reset:disconnects,energy", - "Onoff" => " on off toggle on-for-timer off-for-timer", - "Multi" => " ON:noArg OFF:noArg xtrachannels:noArg", - "Rol" => " closed open stop:noArg pct:slider,0,1,100 delta zero:noArg predefAttr:noArg", - "RgbwW" => " pct dim dimup dimdown dim-for-timer", - "BulbW" => " ct:colorpicker,CT,3000,10,6500 pct:slider,1,1,100", - "RgbwC" => " rgbw rgb:colorpicker,HSV hsv white:slider,0,1,100 gain:slider,0,1,100" -); -## may be used for RgbwC: -## "hsv:colorpicker,HSV" -## "rgb:colorpicker,RGB" -## "white:colorpicker,BRI,0,1,255" - -# Device model by https://kb.shelly.cloud/knowledge-base/ -my %shelly_vendor_ids = ( - "SHSW-1" => "shelly1", # no power metering - "SHSW-L" => "shelly1L", # with AC power metering - "SHSW-PM" => "shelly1pm", - "SHSW-21" => "shelly2", - "SHSW-25" => "shelly2.5", - "SHSW-44" => "shelly4", - "SHDM-1" => "shellydimmer", # Dimmer 1 - "SHDM-2" => "shellydimmer", # Dimmer 2 - "SHIX3-1" => "shellyi3", # shelly ix-3 - "SHUNI-1" => "shellyuni", - "SHPLG2-1" => "shellyplug", - "SHPLG-S" => "shellyplug", - "SHEM" => "shellyem", - "SHEM-3" => "shelly3em", - "SHRGBW2" => "shellyrgbw", - "SHBLB-1" => "shellybulb", - "SHBDUO-1" => "shellybulb", #shelly duo white - "SHCB-1" => "shellybulb", # shelly duo color G10 - "SHVIN-1" => "shellybulb", # shelly vintage (white mode) - "SHHT-1" => "generic", # shelly t&h sensorOK - "SHWT-1" => "generic", # shelly flood sensor - "SHSM-1" => "generic", # shelly smoke sensor - "SHMOS-01" => "generic", # shelly motion sensor - "SHMOS-02" => "generic", # shelly motion sensor 2 - "SHGS-1" => "generic", # shelly gas sensor - "SHDW-1" => "generic", # shelly door/window sensor - "SHDW-2" => "generic", # shelly door/window sensor 2 - "SHBTN-1" => "generic", # shelly button 1 - "SHBTN-2" => "generic", # shelly button 2 - "SHSEN-1" => "generic", # shelly motion & ir-controller - "SHSTRV-01" => "generic", # shelly trv - # 2nd Gen PLUS devices - "SNPL-00110IT" => "shellyplusplug", # italian style - "SNPL-00112EU" => "shellyplusplug", # german style - "SNPL-10112EU" => "shellyplusplug", # german style V2 - "SNPL-00112UK" => "shellyplusplug", # UK style - "SNPL-00116US" => "shellyplusplug", # US style - "SNSW-001X16EU" => "shellyplus1", - "SNSW-001P16EU" => "shellyplus1pm", - "SNSW-002P16EU" => "shellyplus2pm", - "SNSW-102P16EU" => "shellyplus2pm", ## 102 ?? - "SNSN-0024X" => "shellyplusi4", # shelly plus i4 (AC) - "SNSN-0D24X" => "shellyplusi4", # shelly plus i4 (DC) - "SNSN-0013A" => "generic", # shelly plus ht temp&humidity sensor - "SNDM-00100WW" => "shellyplusdimmer", # 0-10V Dimmer - # 2nd Gen PRO devices - "SPSH-002PE16EU" => "shellyprodual", # Shelly Pro Dual Cover PM - "SPSW-001XE16EU" => "shellypro1", - "SPSW-201XE16EU" => "shellypro1", # Shelly Pro 1 v.1 - "SPSW-001PE16EU" => "shellypro1pm", - "SPSW-201PE16EU" => "shellypro1pm", # Shelly Pro 1PM v.1 - "SPSW-002XE16EU" => "shellypro2", - "SPSW-202XE16EU" => "shellypro2", # Shelly Pro 2 v.1 - "SPSW-002PE16EU" => "shellypro2pm", - "SPSW-202PE16EU" => "shellypro2pm", # Shelly Pro 2PM v.1 - "SPSW-003XE16EU" => "shellypro3", - "SPSW-004PE16EU" => "shellypro4pm", # Shelly Pro 4PM v1 - "SPSW-104PE16EU" => "shellypro4pm", # Shelly Pro 4PM v2 - "SPEM-002CEBEU50" => "shellyproem50", # Shelly Pro EM-50 - "SPEM-003CEBEU" => "shellypro3em", - "SPEM-003CEBEU400"=> "shellypro3em", # Shelly Pro 3EM-400 - # Mini Devices - "SNSW-001X8EU" => "shellyplus1", # Shelly Plus 1 Mini - "SNSW-001P8EU" => "shellyplus1pm", # Shelly Plus 1 PM Mini - "SNPM-001PCEU16" => "shellypmmini", # Shelly Plus PM Mini - # Gen3 Devices - "S3SW-001X8EU" => "shellyplus1", # Shelly 1 Mini Gen3 - "S3SW-001P8EU" => "shellyplus1pm", # Shelly 1 PM Mini Gen3 - "S3PM-001PCEU16" => "shellypmmini", # Shelly PM Mini Gen3 - # Misc - "SAWD-0A1XX10EU1" => "walldisplay1" ); -my %shelly_models = ( - #( 0 1 2 3 4 5 6 7 8) - #(relays,rollers,dimmers, meters, NG,inputs, res.,color,modes) - "generic" => [0,0,0, 0,0,0, 0,0,0], - "shellyi3" => [0,0,0, 0,0,3, 0,0,0], # 3 inputs - "shelly1" => [1,0,0, 0,0,1, 0,0,0], # not metering, only a power constant in older fw - "shelly1L" => [1,0,0, 1,0,1, 0,0,0], - "shelly1pm" => [1,0,0, 1,0,1, 0,0,0], - "shelly2" => [2,1,0, 1,0,2, 0,0,2], # relay mode, roller mode - "shelly2.5" => [2,1,0, 2,0,2, 0,0,2], # relay mode, roller mode - "shellyplug" => [1,0,0, 1,0,-1, 0,0,0], # shellyplug & shellyplugS; no input, but a button which is only reachable via Action - "shelly4" => [4,0,0, 4,0,0, 0,0,0], # shelly4pro; inputs not provided by fw v1.6.6 - "shellyrgbw" => [0,0,4, 4,0,1, 0,1,2], # shellyrgbw2: color mode, white mode; metering col 1 channel, white 4 channels - "shellydimmer" => [0,0,1, 1,0,2, 0,0,0], - "shellyem" => [1,0,0, 2,0,0, 0,0,0], # with one control-relay, consumed energy in Wh - "shelly3em" => [1,0,0, 3,0,0, 0,0,0], # with one control-relay, consumed energy in Wh - "shellybulb" => [0,0,1, 1,0,0, 0,1,2], # shellybulb & shellybulbrgbw: color mode, white mode; metering is in any case 1 channel - "shellyuni" => [2,0,0, 0,0,2, 0,0,0], # + analog dc voltage metering - #-- 2nd generation devices - "shellyplusplug"=> [1,0,0, 1,1,-1, 0,0,0], - "shellypluspm" => [0,0,0, 1,1,0, 0,0,0], - "shellyplus1" => [1,0,0, 0,1,1, 0,0,0], - "shellyplus1pm" => [1,0,0, 1,1,1, 0,0,0], - "shellyplus2pm" => [2,1,0, 2,1,2, 0,0,2], # switch profile, cover profile - "shellyplusdimmer"=>[0,0,1,0,1,2, 0,0,0], # one instance of light, 0-10V output - "shellyplusi4" => [0,0,0, 0,1,4, 0,0,0], - "shellypro1" => [1,0,0, 0,1,2, 0,0,0], - "shellypro1pm" => [1,0,0, 1,1,2, 0,0,0], - "shellypro2" => [2,0,0, 0,1,2, 0,0,0], - "shellypro2pm" => [2,1,0, 2,1,2, 0,0,2], # switch profile, cover profile - "shellypro3" => [3,0,0, 0,1,3, 0,0,0], # 3 potential free contacts - "shellypro4pm" => [4,0,0, 4,1,4, 0,0,0], - "shellyproem50" => [1,0,0, 1,1,0, 0,0,0], # has two single-phase meter and one relay - "shellypro3em" => [0,0,0, 1,1,0, 0,0,0], # has one (1) three-phase meter - "shellyprodual" => [0,2,0, 4,1,4, 0,0,0], - "shellypmmini" => [0,0,0, 1,1,0, 0,0,0], # similar to ShellyPlusPM - "walldisplay1" => [1,0,0, 0,2,1, 0,0,0] # similar to ShellyPlus1PM - ); - -my %shelly_events = ( # events, that can be used by webhooks; key is mode, value is shelly-event - #Gen1 devices - "generic" => [""], - "shellyi3" => ["btn_on_url","btn_off_url","shortpush_url","longpush_url", - "double_shortpush_url","triple_shortpush_url","shortpush_longpush_url","longpush_shortpush_url"], - "shelly1" => ["btn_on_url","btn_off_url","shortpush_url","longpush_url","out_on_url","out_off_url"], - "shelly1L" => [""], - "shelly1pm" => [""], - "shelly2" => [""], - "shelly2.5" => [""], - "shellyplug" => ["btn_on_url","out_on_url","out_off_url"], - "shelly4" => [""], - "shellyrgbw" => ["longpush_url","shortpush_url"], - "shellydimmer" => ["btn1_on_url","btn1_off_url","btn1_shortpush_url","btn1_longpush_url", - "btn2_on_url","btn2_off_url","btn2_shortpush_url","btn2_longpush_url"], - "shellyem" => ["out_on_url","out_off_url","over_power_url","under_power_url"], - "shelly3em" => [""], - "shellybulb" => ["out_on_url","out_off_url"], - "shellyuni" => ["btn_on_url","btn_off_url","shortpush_url","longpush_url","out_on_url","out_off_url","adc_over_url","adc_under_url"], - #Gen2 components; event given as key 'event' by rpc/Webhook.List - "relay" => ["switch.on", "switch.off"], # events of the switch component - "roller" => ["cover.stopped","cover.opening","cover.closing","cover.open","cover.closed"], - "switch" => ["input.toggle_on","input.toggle_off"], # for input instances of type switch - "button" => ["input.button_push","input.button_longpush","input.button_doublepush","input.button_triplepush"], # for input instances of type button - "emeter" => ["em.active_power_change","em.voltage_change","em.current_change"], - "pm1" => ["pm1.apower_change","pm1.voltage_change","pm1.current_change"], - "touch" => ["input.touch_swipe_up","input.touch_swipe_down","input.touch_multi_touch"], - "addon" => ["temperature.change"] -); - -my %fhem_events = ( # events, that can be used by webhooks; key is shelly-event, value is event sent to Fhem - #Gen 1 - "out_on_url" => "out_on", - "out_off_url" => "out_off", - "roller_stopp_url" => "stopped", - "roller_open_url" => "stopped", - "roller_close_url" => "stopped", - "btn_on_url" => "button_on", - "btn_off_url" => "button_off", - "lp_on_url" => "", # Shelly1pm: button long pressed - "lp_off_url" => "", - "shortpush_url" => "single_push", - "longpush_url" => "long_push", - "double_shortpush_url" => "double_push", - "triple_shortpush_url" => "triple_push", - "shortpush_longpush_url" => "short_long_push", - "longpush_shortpush_url" => "long_short_push", - "adc_over_url" => "", - "adc_under_url" => "", - "report_url" => "", - "ext_temp_over_url" => "", - "ext_temp_under_url" => "", - "ext_hum_over_url" => "", - "ext_hum_under_url" => "", - #Shelly dimmer - "btn1_on_url" => "button_on 0", - "btn1_off_url" => "button_off 0", - "btn1_shortpush_url" => "single_push 0", - "btn1_longpush_url" => "long_push 0", - "btn2_on_url" => "button_on 1", - "btn2_off_url" => "button_off 1", - "btn2_shortpush_url" => "single_push 1", - "btn2_longpush_url" => "long_push 1", - - #Gen 2 - #relay - "switch.on" => "out_on", - "switch.off" => "out_off", - #roller - "cover.stopped" => "stopped", - "cover.opening" => "opening", - "cover.closing" => "closing", - "cover.open" => "is_open", - "cover.closed" => "is_closed", - #switch - "input.toggle_on" => "button_on", - "input.toggle_off" => "button_off", - #button - "input.button_push" => "single_push", - "input.button_longpush" => "long_push", - "input.button_doublepush" => "double_push", - "input.button_triplepush" => "triple_push", - #touch - "input.touch_swipe_up" => "touch_up", - "input.touch_swipe_down" => "touch_down", - "input.touch_multi_touch" => "touch_multi", - #emeter - "em.active_power_change" => "Active_Power", - "em.voltage_change" => "Voltage", - "em.current_change" => "Current", - #mini-emeter (shellypmmini) - "pm1.apower_change" => "power", - "pm1.voltage_change" => "voltage", - "pm1.current_change" => "current", - #addon - "temperature.measurement" => "tempC", - "temperature.change" => "tempC", - # translations - "S" => "single_push", - "L" => "long_push", - "SS" => "double_push", - "SSS" => "triple_push", - "SL" => "short_long_push", - "LS" => "long_short_push", - "short_push" => "S", - "single_push" => "S", - "long_push" => "L", - "double_push" => "SS", - "triple_push" => "SSS" -); - -my %shelly_regs = ( - "relay" => "reset=1\x{27f6}factory reset\n". - "appliance_type=<string>\x{27f6}custom configurabel appliance type\n". # uni - "has_timer=0|1\x{27f6}wheather there is an active timer on the channel \n". # uni - "overpower=0|1\x{27f6}wheather an overpower condition has occured \n". # uni !Sh1 1pm 4pro plug - "default_state=off|on|last|switch\x{27f6}state after power on\n". - "btn_type=momentary|toggle|edge|detached|action|cycle|momentary_on_release\x{27f6}type of local button\n". # extends for uni *1L - "btn_reverse=0|1\x{27f6}invert local button\n". # *1L Sh1L has two buttons - "auto_on=<seconds>\x{27f6}timed on\n". - "auto_off=<seconds>\x{27f6}timed off\n". - "schedule=0|1\x{27f6}enable schedule timer\n". - "max_power=<watt>\x{27f6}power threshold above which an overpower condition will be triggered", # sh1pm sh1L !sh2 2.5 4pro plug - "roller" => "reset=1\x{27f6}factory reset\n". - "maxtime=<seconds>\x{27f6}maximum time needed to completely open or close\n". - "maxtime_open=<seconds>\x{27f6}maximum time needed to completely open\n". - "maxtime_close=<seconds>\x{27f6}maximum time needed to completely close\n". - "default_state=stop|open|close|switch\x{27f6}state after power on\n". - "swap=true|false\x{27f6}swap open and close directions\n". - "swap_inputs=true|false\x{27f6}swap inputs\n". - "input_mode=openclose|onebutton\x{27f6}two or one local button\n". - "button_type=momentary|toggle|detached|action\x{27f6}type of local button\n". # frmly btn_type - "btn_reverse=true|false\x{27f6}whether to invert the state of input switch\n". - "state=stop|open|close\x{27f6}state of roller\n". - "power=<watt>\x{27f6}current power consumption\n". - "safety_switch=true|false\x{27f6}whether the safety input is currently triggered\n". - "schedule=true|false\x{27f6}whether scheduling is enabled\n". - "obstacle_mode=disabled|while_opening|while_closing|while_moving\x{27f6}when to react on obstacles\n". - "obstacle_action=stop|reverse\x{27f6}what to do\n". - "obstacle_power=<watt>\x{27f6}power threshold for detection\n". - "obstacle_delay=<seconds>\x{27f6}delay after motor start to watch\n". - "safety_mode=disabled|while_opening|while_closing|while_moving\x{27f6}safety mode=2nd button\n". - "safety_action=stop|pause|reverse\x{27f6}action when safety mode\n". - "safety_allowed_on_trigger=none|open|close|all\x{27f6}commands allowed in safety mode\n". - "off_power=<watt>\x{27f6}power value below the roller is considered \'stopped\'\n". - "positioning=true|false\x{27f6}whether the device is calibrated for positioning control", - "color" => "reset=1\x{27f6}factory reset\n". # shellyrgbw2 color-mode: /settings/color/0 || /settings/light/0 - "name=<name>\x{27f6}channel name\n". - "transition=<milliseconds>\x{27f6}transition time between on and off, 0...5000\n". - "effect=0|1|2|3\x{27f6}apply an effect 1=Meteor Shower 2=Gradual Change 3=Flash\n". # !|4|5|6 - "default_state=off|on|last\x{27f6}state after power on\n". - "btn_type=momentary|toggle|edge|detached\x{27f6}type of local button\n". - "btn_reverse=0|1\x{27f6}invert local button\n". - "auto_on=<seconds>\x{27f6}timed on\n". - "auto_off=<seconds>\x{27f6}timed off\n". - "schedule=0|1\x{27f6}enable schedule timer\n". - "btn_type=momentary|toggle|edge|detached|action\x{27f6}type of local button\n". - "btn_reverse=0|1\x{27f6}invert local button", - "bulbw" => "reset=1\x{27f6}factory reset\n". # shellyrgbw2 white-mode: /settings/white/{index} || /settings/light/{index} bulb white:/settings/light/0 - "brightness=<number>\x{27f6}output level 0...100\n". - "transition=<milliseconds>\x{27f6}transition time between on and off, 0...5000\n". - "default_state=off|on|last\x{27f6}state after power on\n". # !switch - "auto_on=<seconds>\x{27f6}timer to turn ON after every OFF command\n". - "auto_off=<seconds>\x{27f6}timer to turn OFF after every ON command\n". - "schedule=0|1\x{27f6}enable schedule timer", - "white" => "name=<name>\x{27f6}channel name\n". # additional registers for rgbw-white - "btn_type=momentary|toggle|edge|detached\x{27f6}type of local button\n". - "btn_reverse=0|1\x{27f6}invert local button\n". - "out_on_url=<url>\x{27f6}url when output is activated\n". - "out_off_url=<url>\x{27f6}url when output is deactivated", - "light" => "reset=1\x{27f6}factory reset\n". # shellydimmer /settings/light/0 - # "reset=0|1\x{27f6}whether factory reset via 5-time flip of the input switch is enabled\n". - # "name=<name>\x{27f6}dimmer device name\n". # does not work properly - "default_state=off|on|last|switch\x{27f6}state after power on\n". - "auto_on=<seconds>\x{27f6}timer to turn the dimmer ON after every OFF command\n". - "auto_off=<seconds>\x{27f6}timer to turn the dimmer OFF after every ON command\n". - "btn_type=one_button|dual_button|toggle|edge|detached|action\x{27f6}type of local button\n". - "btn_debounce=<milli seconds>\x{27f6}button debounce time (60...200ms)\n". - "swap_inputs=0|1\x{27f6}swap inputs", - "input" => "reset=1\x{27f6}factory reset\n". - "name=<name>\x{27f6}input name\n". - "btn_type=momentary|toggle\x{27f6}type of local button\n". - "btn_reverse=0|1\x{27f6}invert local button\n" - ); - -my %predefAttrs = ( - "roller_webCmd" => "open:up:down:closed:half:stop:position", - "roller_eventMap_closed100" => "/delta -15:up/delta +15:down/pos 50:half/", - "roller_eventMap_open100" => "/delta +15:up/delta -15:down/pos 50:half/", - "roller_cmdIcon" => "open:control_arrow_upward\@blue up:control_arrow_up\@blue down:control_arrow_down\@blue closed:control_arrow_downward\@blue". - " stop:rc_STOP\@blue half:fts_shutter_50\@blue", - "roller_open100" => "open:fts_shutter_100:closed". - " closed:fts_shutter_10:open". - " half:fts_shutter_50:closed". - " drive-up:fts_shutter_up\@red:stop". - " drive-down:fts_shutter_down\@red:stop". - " pct-100:fts_window_2w:closed". - " pct-90:fts_shutter_10:closed". - " pct-80:fts_shutter_20:closed". - " pct-70:fts_shutter_30:closed". - " pct-60:fts_shutter_40:closed". - " pct-50:fts_shutter_50:closed". - " pct-40:fts_shutter_60:open". - " pct-30:fts_shutter_70:open". - " pct-20:fts_shutter_80:open". - " pct-10:fts_shutter_90:open". - " pct-0:fts_shutter_100:open", - "roller_closed100" => "open:fts_shutter_10:closed". - " closed:fts_shutter_100:open". - " half:fts_shutter_50:closed". - " drive-up:fts_shutter_up\@red:stop". - " drive-down:fts_shutter_down\@red:stop". - " pct-100:fts_shutter_100:open". - " pct-90:fts_shutter_90:closed". - " pct-80:fts_shutter_80:closed". - " pct-70:fts_shutter_70:closed". - " pct-60:fts_shutter_60:closed". - " pct-50:fts_shutter_50:closed". - " pct-40:fts_shutter_40:open". - " pct-30:fts_shutter_30:open". - " pct-20:fts_shutter_20:open". - " pct-10:fts_shutter_10:open". - " pct-0:fts_window_2w:closed" - ); - -my %si_units = ( - "time" => [""," sec"], - "time_ms" => [""," ms"], # Milli-Seconds - "current" => [""," A"], - "voltage" => [""," V"], - "power" => [""," W"], # Wirkleistung - "reactivepower" => [""," var"], # Blindleistung - "apparentpower" => [""," VA"], # Scheinleistung - "energy" => [""," Wh"], # Arbeit; - "frequency" => [""," Hz"], - "tempC" => [""," °C"], # Celsius - "relHumidity" => [""," %"], - "pct" => [""," %"], - "illum" => [""," lux"], # illuminace eg WallDisplay - "ct" => [""," K"], # color temperature / Kelvin - "rssi" => [""," dBm"] # deziBel Miniwatt - ); - - my %energy_units = ( #si, faktor, decimals - "none" => [ "Wh", 1, 0 ], - "normal" => [ "Wh", 1, 1 ], - "normal2" => [ "kWh",0.001, 4 ], - "ISO" => [ "kJ", 3.6, 0 ] - ); - -my %peripherals = ( - # Peripheral type => Component Type - "analog_in" => "input", - "digital_in" => "input", - "dht22" => "humidity", - "ds18b20" => "temperature", - "voltmeter" => "voltmeter" -); - - - ######################################################################################## # # Shelly_Initialize @@ -634,12 +739,13 @@ my %peripherals = ( ######################################################################################## sub Shelly_Initialize ($) { - my ($hash) = @_;#Debug "running Shelly_Initialize"; - + my ($hash) = @_; + $hash->{DefFn} = "Shelly_Define"; $hash->{UndefFn} = "Shelly_Undef"; $hash->{DeleteFn} = "Shelly_Delete"; $hash->{AttrFn} = "Shelly_Attr"; + $hash->{NotifyFn} = "Shelly_Notify"; $hash->{GetFn} = "Shelly_Get"; $hash->{SetFn} = "Shelly_Set"; $hash->{RenameFn} = "Shelly_Rename"; @@ -655,7 +761,7 @@ sub Shelly_Initialize ($) { $attributes{'input'}. $attributes{'metering'}. $attributes{'showunits'}. - " webhook:none,".join(",",devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1')). + " webhook:".join(",",devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1')). ## none, $attributes{'emeter'}. " verbose:0,1,2,3,4,5". " ".$readingFnAttributes; @@ -672,227 +778,190 @@ sub Shelly_Initialize ($) { sub Shelly_Define($$) { my ($hash, $def) = @_; my @a = split("[ \t][ \t]*", $def); - my $name=$hash->{NAME};#Debug "running Shelly_Define for $name"; + my $name=$hash->{NAME}; + my $user="admin"; + my $pwd=""; + + if( @a == 4 ){ # user:password + if( $a[3] =~ /\:/ ){ + $a[3] =~ m/(\S*):(\S*)/; + $user=$1; + $pwd =$2; + }else{ + $pwd =$a[3]; + } + Log3 $name,6,"[Shelly_define] got user=$user and password=$pwd"; + $attr{$name}{shellyuser}=$user; + Shelly_Set($hash,$name,"password",$pwd); + # strip off user and password from DEF: + $hash->{DEF}=$a[2]; + } return "[Shelly_Define] $name: Define the IP address of the Shelly device as a parameter" - if(@a != 3); - return "[Shelly_Define] $name: invalid IP address ".$a[2]." of Shelly" - if( $a[2] !~ m|\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?(\:\d+)?| ); - + if(@a < 3); + + if( $a[2] =~ m|\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?(\:\d+)?| ){ + # we have a valid ip-address + }elsif( $a[2] =~ m|^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{3,63}(?{TCPIP} = $dev; - $hash->{INTERVAL} = AttrVal($hash->{NAME},"interval",$defaultINTERVAL); # Updates each minute, if not set as attribute - +# $hash->{TCPIP} = $dev; + $hash->{helper}{settings_time} = 0; # + $hash->{units}=0 if( !defined($hash->{units}) ); + # use hidden AttrList to make attributes changeable by Shelly_Attr() $hash->{'.AttrList'} = $modules{Shelly}{'AttrList'}; - - $modules{Shelly}{defptr}{$a[0]} = $hash; - - #-- InternalTimer blocks if init_done is not true - my $oid = $init_done; - $init_done = 1; - - Log3 $name,4,"[Shelly_Define] $name: setting internal timer to get status of device"; - # try to get model and mode, adapt attr-list - # Note: to have access to the attributes, we have to finish Shelly_Define first - my $now=time(); - InternalTimer($now+4+rand(4), "Shelly_get_model", $hash); - # check / change CSRF-Token - InternalTimer($now+8+rand(10),"Shelly_actionCheck", $hash); #calling only on restart - - #-- perform status update etc. at a slightly random interval - InternalTimer($now+18+rand(4), "Shelly_status", $hash); - InternalTimer($now+22+rand(4), "Shelly_EMData", $hash); - InternalTimer($now+26+rand(4), "Shelly_shelly", $hash); - $init_done = $oid; - if( defined(AttrVal($name,"ShellyName",undef)) ){ - fhem("deleteattr $name ShellyName"); - Log3 $hash->{NAME},1,"[Shelly_Define] $name: Attribut \'ShellyName\' removed. Use \'set $name \' instead"; + $modules{Shelly}{defptr}{$a[0]} = $hash; + delete $hash->{SHELLY}; + if( $init_done ){ + $hash->{INTERVAL} = AttrVal($hash->{NAME},"interval",$defaultINTERVAL); # Updates each minute, if not set as attribute + Log3 $name,5,"[Shelly_define] Define is calling get modell for device $name, init=$init_done"; # && $hash->{INTERVAL}>0 + Shelly_HttpRequest( $hash,"/shelly","","Shelly_getModel" ); + InternalTimer(time()+0.6, "Refresh", $hash); # perform a browser refresh } return undef; } # end Shelly_Define() +sub Refresh { ##see also forum topic 48736.0 + Log3 undef,1,"perform a browser refresh of $FW_wname"; + fhem("trigger $FW_wname JS:location.reload(true)"); # try a browser refresh ?? +} + + ######################################################################################## -# -# Shelly_get_model - try to get type/vendor_id (model) and mode (if given) from device -# adapt AttrList to the model -# acts as callable program Shelly_get_model($hash) -# and as callback program Shelly_get_model($hash,$err,$data) -# -# Parameter hash, error, data +# +# Shelly_getModel - get type/vendor_id (model) and mode (if given) from device +# Parameter: parameter-hash, JSON-hash # ######################################################################################## -sub Shelly_get_model { - my ($hash, $count, $err, $data) = @_; - my $name = $hash->{NAME}; - if( AttrVal($name,"model",undef) ){ - Log3 $name,5,"[Shelly_get_model] $name: model almost identified, aborting successful";#5 - return "model almost identified"; - } - # a counter to prevent endless looping in case Shelly does not answer or the answering device is not a Shelly - $count=1 if( !$count ); - if($count>3){ - Shelly_error_handling($hash,"Shelly_get_model", "aborted: cannot get model for device \'$name\'"); - return; - } - if( $hash && !$err && !$data ){ - my $creds = Shelly_pwd($hash); - my $url = "http://$creds".$hash->{TCPIP}; - #-- try to get type/model and profile/mode of Shelly - first gen - Log3 $name,4,"[Shelly_get_model] try to get model for device $name as first gen"; - Log3 $name,5,"[Shelly_get_model] issue a non blocking call: $url/settings"; - HttpUtils_NonblockingGet({ - url => $url."/settings", - timeout => 4, - callback => sub($$$$){ Shelly_get_model($hash,$count,$_[1],$_[2]) } - }); - $count++; - #-- try to get type/model and profile/mode of Shelly - second gen - Log3 $name,4,"[Shelly_get_model] try to get model for device $name as second gen"; - Log3 $name,5,"[Shelly_get_model] issue a non blocking call: $url/rpc/Shelly.GetDeviceInfo"; - HttpUtils_NonblockingGet({ - url => $url."/rpc/Shelly.GetDeviceInfo", - timeout => 4, - callback => sub($$$$){ Shelly_get_model($hash,$count,$_[1],$_[2]) } - }); - $count++; - return "wait until browser refresh"; - } - - if( $hash && $err && AttrVal($name,"model","undef") eq "undef" ){ - $err = "searching" if( $err =~ /JSON/ ); - Shelly_error_handling($hash,"Shelly_get_model",$err); - return; - } - - my ($json,$jhash); - if( $hash && $data ){ - Log3 $name,4,"[Shelly_get_model] $name: received ".length($data)." byte of data from device"; - Log3 $name,5,"[Shelly_get_model] $name: received data is: \n$data "; - - if( $data eq "Not Found" ){ - # when checking out Shellies software generation, this is intentionally no error - Log3 $name,5,"[Shelly_get_model] no endpoint found for URL on device $name"; - return $data; - } - $json = JSON->new->utf8; - $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - Log3 $name,1,"[Shelly_get_model] standard decoding: has invalid JSON data for device $name"; - $json = JSON->new->utf8->relaxed; - $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - Shelly_error_handling($hash,"Shelly_get_model","relaxed decoding: invalid JSON data, try to call /shelly"); - HttpUtils_NonblockingGet({ - url => "http://".Shelly_pwd($hash).$hash->{TCPIP}."/shelly", - timeout => 4, - callback => sub($$$$){ Shelly_get_model($hash,$count,$_[1],$_[2]) } - }); - $count++; - return; +sub Shelly_getModel { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $name = $hash->{NAME}; + my $call = $param->{cmd}; + my ($model_id,$model,$mode,$auth,$mac); + + if( $call eq "/shelly" ){ # the /shelly call is not blocked by authentication! + if( defined($jhash->{type}) ){ #1G + # set the type / vendor-id as internal + $model_id=$jhash->{type}; + $mode=$jhash->{mode}; # mode is not supported by all devices within the /shelly call + $auth=$jhash->{auth}; + }elsif( defined($jhash->{model}) ){ #2G + # set the type / vendor-id as internal + $model_id=$jhash->{model}; + $mode=$jhash->{profile}; + $auth=$jhash->{auth_en}; }else{ - Log3 $name,1,"[Shelly_get_model] decoded JSON with relaxed decoding for device $name"; + Log3 $name,4,"[Shelly_getModel] $name: have no result with the /shelly call, calling /settings"; + Shelly_HttpRequest( $hash,"/settings",undef,"Shelly_getModel" ); + } + ### MAC + my $mac = $jhash->{mac}; + $mac =~ m/(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)/; # matching word characters (alphanumeric plus '_') + $mac = sprintf("%s:%s:%s:%s:%s:%s",$1,$2,$3,$4,$5,$6); + # $mac .= "_(Wifi)" if( ReadingsVal($name,"model_family","unknown") =~ /Pro/ ); # we cannot get MAC of LAN adapter + readingsSingleUpdate($hash,"mac",$mac,1); + $hash->{MAC}=$mac; # we need this to find AccessPoint clients + }elsif( $call eq "/settings" ){ + if( defined($jhash->{device}{type}) ){ + # set the type / vendor-id as internal + $model_id=$jhash->{device}{type}; + $mode=$jhash->{mode}; + }else{ + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetDeviceInfo",undef,"Shelly_getModel" ); + } + }elsif( $call eq "/rpc/Shelly.GetDeviceInfo" ){ + if( defined($jhash->{model}) ){ + # set the type / vendor-id as internal + $model_id=$jhash->{model}; + $mode=$jhash->{profile}; + }else{ #type not detected + Log3 $name,2,"[Shelly_getModel] Unsuccessful: Got no \'type\' (Vendor-ID) for device $name, proposed model is \'generic\'"; + readingsSingleUpdate($hash,"state","type (Vendor-ID) not detected",1); + Log3 $name,2,"[Shelly_getModel] type not found, proposed model of device $name is \'generic\'"; + $model_id = "unknown"; + $model = "generic"; } - } } -if(0){ - # get Shellies Name either from the /settings call or from the /rpc/Shelly.GetDeviceInfo call - if( defined($jhash->{'name'}) ){ #ShellyName - ##fhem("set $name name " . $jhash->{'name'} ); - $attr{$hash->{NAME}}{ShellyName} = $jhash->{'name'}; - }else{ - # if Shelly is not named, set name of Shelly equal to name of Fhem-device - ##fhem("set $name name " . $name ); - $attr{$hash->{NAME}}{ShellyName} = $name; - } -} - my ($model,$mode); - - #-- for all 1st gen models get type (vendor_id) and mode from the /settings call - if( $jhash->{'device'}{'type'} ){ - # set the type / vendor-id as internal - $hash->{SHELLY}=$jhash->{'device'}{'type'}; - # get mode, only multi-mode devices - if( $jhash->{'mode'} ){ - $mode = $jhash->{'mode'}; - Log3 $name,1,"[Shelly_get_model] the attribute \'mode\' of device $name is set to \'$mode\' "; - $attr{$hash->{NAME}}{mode} = $mode; # _Attr + if( defined($model_id) ){ + Log3 $name,4,"[Shelly_getModel] device $name is of model_id $model_id"; + $model = $shelly_vendor_ids{$model_id}[0]; + my $device_name = $shelly_vendor_ids{$model_id}[1]; + my $device_family = $shelly_family{substr($model_id,0,2)}; + readingsSingleUpdate($hash,"model_ID",$model_id,1); + readingsSingleUpdate($hash,"model_family",$device_family,1); + readingsSingleUpdate($hash,"model_name",$device_name,1); + if( $device_family ne "Gen1" ){ + my $device_function = $shelly_category{substr($model_id,2,2)}; + readingsSingleUpdate($hash,"model_function",$device_function,1); } - #-- for some 1st gen models get type (vendor_id), from the /shelly call - }elsif( $jhash->{'type'} ){ - # set the type / vendor-id as internal - $hash->{SHELLY}=$jhash->{'type'}; - - #-- for all 2nd gen models get type (vendor_id) and mode from the /rpc/Shelly.GetDeviceInfo call - }elsif( $jhash->{'model'} ){ # 2nd-Gen-Device - # set the type / vendor-id as internal - $hash->{SHELLY}=$jhash->{'model'}; - if( $jhash->{'profile'} ){ - $mode = $jhash->{'profile'}; - Log3 $name,5,"[Shelly_get_model] $name is of 2nd-gen profile \'$mode\'"; - $mode =~ s/switch/relay/; # we use 1st-Gen modes - $mode =~ s/cover/roller/; - Log3 $name,1,"[Shelly_get_model] the attribute \'mode\' of device $name is set to \'$mode\' "; - $attr{$hash->{NAME}}{mode} = $mode; # _Attr - } - }elsif( 0 && AttrVal($name,"model","generic") ne "generic"){ - $model = AttrVal($name,"model","generic"); - $mode = AttrVal($name,"mode",undef) if( AttrVal($name,"mode",undef) ); - Log3 $name,5,"[Shelly_get_model] $name has existing definiton for model=$model".($mode?" and mode=$mode":""); - }else{ #type not detected - Log3 $name,2,"[Shelly_get_model] Unsuccessful: Got no \'type\' (Vendor-ID) for device $name, proposed model is \'generic\'"; - readingsSingleUpdate($hash,"state","type (Vendor-ID) not detected",1); - } - - if( $hash->{SHELLY} ){ - Log3 $name,2,"[Shelly_get_model] device $name is of type ".$hash->{SHELLY}; - $model = $shelly_vendor_ids{$hash->{'SHELLY'}}; if ( $model ){ - Log3 $name,2,"[Shelly_get_model] discovered model=$model for device $name"; + Log3 $name,4,"[Shelly_getModel] $call: discovered model=$model for device $name"; }else{ - Log3 $name,2,"[Shelly_get_model] device $name is of type \'".$hash->{SHELLY}."\' but we have no key of that name, proposed model is \'generic\'"; + Log3 $name,1,"[Shelly_getModel] $call: device $name is of type \'$model_id\' but we have no key of that name, proposed model is \'generic\'"; readingsSingleUpdate($hash,"state","type key not found, set to \"generic\" ",1); $model = "generic"; } - }else{ - Log3 $name,2,"[Shelly_get_model] type not found, proposed model of device $name is \'generic\'"; - $hash->{SHELLY} = "unknown"; - $model = "generic"; } - - - if( defined($attr{$name}{model}) ){ + if( defined($model) ){ + if( !defined($attr{$name}{model}) ){ + # set the model-attribute when the model attribute is not set yet + $attr{$hash->{NAME}}{model} = $model; # _Attr + Log3 $name,4,"[Shelly_getModel] $call: the attribute \'model\' of device $name is set to \'$model\' "; + # reset time of last settings call + $hash->{helper}{settings_time}=0; + }else{ + # model is already given as attribute my $model_old = $attr{$name}{model}; if( $model_old eq "generic" && $model ne "generic" ){ - Log3 $name,2,"[Shelly_get_model] the model of device $name is already defined as generic, and will be redefined as \'$model\' "; + Log3 $name,2,"[Shelly_getModel] $call: the model of device $name is already defined as generic, and will be redefined as \'$model\' "; $attr{$hash->{NAME}}{model} = $model; + }elsif( $model_old eq $model ){ + Log3 $name,4,"[Shelly_getModel] $call: the model of device $name is already defined as \'$model\' "; }else{ - Log3 $name,2,"[Shelly_get_model] the model of device $name is already defined as \'$model_old\' "; + Log3 $name,3,"[Shelly_getModel] $call: the model of device $name is already defined as \'$model_old\', might be $model"; readingsSingleUpdate($hash,"state","model already defined as \'$model_old\', might be $model",1); + $model = $model_old; # old model will not be changed } - }else{ - # set the model-attribute when the model attribute is not set yet - $attr{$hash->{NAME}}{model} = $model; # _Attr - Log3 $name,1,"[Shelly_get_model] the attribute \'model\' of device $name is set to \'$model\' "; - Shelly_Attr("set",$name,"model",$model,undef); + } + Shelly_Attr("set",$name,"model",$model,undef); # set the .AttrList + if( defined($mode) && $shelly_models{$model}[8]>1 ){ # must be a multi-mode device + $mode =~ s/switch/relay/; # we use 1st-Gen modes + $mode =~ s/cover/roller/; + Log3 $name,3,"[Shelly_getModel] $call: the mode/profile of device $name is set to \'$mode\' "; + $attr{$hash->{NAME}}{mode} = $mode; + }else{ + delete($attr{$hash->{NAME}}{mode}); + } + } + if( defined($auth) && $auth==1 && !defined(AttrVal($name,"shellyuser",undef)) && $shelly_models{$model}[4]==0 ){ + Shelly_error_handling($hash,"Shelly_getModel","Authentication required",1); + return; + }else{ + readingsSingleUpdate($hash,"state","initialized",1); } - - ###################################################################################### - readingsSingleUpdate($hash,"state","initialized",1); - InternalTimer(time()+6, "Refresh", $hash); - delete($attr{$hash->{NAME}}{mode}) if( $shelly_models{$model}[8]<2 ); # no multi-mode device - delete($hash->{helper}{Sets}); # build up the sets-dropdown with next refresh - return; -} #end Shelly_get_model + delete($hash->{helper}{Sets}); # build up the sets-dropdown with next refresh + + if( $param->{cmd} eq "/shelly" && $shelly_models{$model}[8]>1 && $shelly_models{$model}[4]==0 ){ + # searching for 'mode' of multimode Gen1 devices, eg. ShellyRGBW + Log 1,"[Shelly_getModel] searching for mode of $name"; + Shelly_HttpRequest( $hash,"/settings",undef,"Shelly_getModel" ); + }else{ + # start cyclic update of status & settings + Shelly_Set($hash,$name,"startTimer"); + Shelly_status($hash); + } +} # END Shelly_getModel() -sub Refresh { ##see also forum topic 48736.0 - Log3 undef,1,"perform a browser refresh"; - fhem("trigger $FW_wname JS:location.reload(true)"); # try a browser refresh ?? -} ####################################################################################### # @@ -906,6 +975,7 @@ sub Shelly_Delete ($) { my ($hash) = @_; my $name = $hash->{NAME}; my ($err, $sh_pw) = setKeyValue("SHELLY_PASSWORD_$name", undef); + Log3 $name,1,"[Shelly_Delete] $name deleted"; return undef; } @@ -923,7 +993,7 @@ sub Shelly_Undef ($) { ##if( !defined($hash->{CMD}) || $hash->{CMD} ne "del" ){ ## fhem("deleteattr $name webhook"); # delete Actions on shelly ## $hash->{CMD}="del"; - ## InternalTimer(time()+25,"Shelly_Undef",$hash,0); + ## InternalTimer(time()+25,"Shelly_Undef",$hash,0); ## return; ##} delete($modules{Shelly}{defptr}{NAME}); @@ -963,16 +1033,16 @@ sub Shelly_Rename ($$) { sub Shelly_Attr(@) { my ($cmd,$name,$attrName, $attrVal, $RR) = @_; - + my $hash = $main::defs{$name}; my $error; # will be set to a message string in case of error - my $regex; - + my $regex; + my $model = AttrVal($name,"model","generic"); my $mode = AttrVal($name,"mode",""); - Log3 $name,4,"[Shelly_Attr] $name: called with command $cmd for attribute $attrName".(defined($attrVal)?", value=$attrVal":"")." init=$init_done";#5 - - #--------------------------------------- + Log3 $name,4,"[Shelly_Attr] $name: called with command \'$cmd\' for attribute \'$attrName\'".(defined($attrVal)?", value=$attrVal":"")." init=$init_done";#5 + + #--------------------------------------- if( $cmd eq "set" && $attrName eq "model" ){ $regex = "((".join(")|(",(keys %shelly_models))."))"; if( $attrVal !~ /$regex/ && $init_done ){ @@ -980,33 +1050,30 @@ sub Shelly_Attr(@) { Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; } - #++++++++ - - Log3 $name,5,"[Shelly_Attr] $name is set to model $attrVal and has mode=$mode, attribute list will be adapted";# \n".$hash->{'.AttrList'}; #5 - + + Log3 $name,5,"[Shelly_Attr] $name is set to model $attrVal and has mode=$mode, attribute list will be adapted";# \n".$hash->{'.AttrList'}; #5 + # set the mode-attribute (when we have a multimode device) #if ( $mode && (( $shelly_models{$model}[0]>0 && $shelly_models{$model}[1]>0 ) || $model=~/rgbw/ || $model=~/bulb/ ) ){ - if( $mode && $shelly_models{$attrVal}[8]>1 ){ + if( $mode && $shelly_models{$attrVal}[8]>1 ){ Log3 $name,5,"[Shelly_Attr] discovered mode=$mode for device $name"; $attr{$hash->{NAME}}{mode} = $mode; - $hash->{MOVING}="stopped" + $hash->{MOVING}="stopped" if( $mode eq "roller" ); # first initialize } - - - ############################################################# + ############################################################# #-- change attribute list depending on model w. hidden AttrList ## my $AttrList = $hash->{'.AttrList'};#$modules{Shelly}{'AttrList'}; - + # replace all other models, except generic if( $attrVal ne "generic" ){ $hash->{'.AttrList'} =~ s/,(\S+?)\s/,$attrVal /; }else{ $hash->{'.AttrList'} =~ s/mode:(\S+?)\s//; # no mode } - - if( $attrVal =~ /shelly(plus|pro)?2.*/ ){ + + if( $attrVal =~ /shelly(plus|pro)?2.*/ ){ $hash->{'.AttrList'} =~ s/,white,color//; $hash->{'.AttrList'} =~ s/( maxtime )/ /; # we have almost maxtime_open maxtime_close }elsif( $attrVal =~ /shelly(rgbw|bulb)/){ @@ -1020,7 +1087,7 @@ sub Shelly_Attr(@) { if( $shelly_models{$attrVal}[5]==0 ){ # no inputs, eg. shellyplug $hash->{'.AttrList'} =~ s/ showinputs:show,hide//; } - + if( $shelly_models{$attrVal}[2]==0 ){ # no dimmer $hash->{'.AttrList'} =~ s/ dimstep//; } @@ -1032,7 +1099,7 @@ sub Shelly_Attr(@) { $hash->{helper}{Total_Energy_S}=0; #-- initialize calculation of integrated power value $hash->{helper}{power} = 0; - $hash->{helper}{powerCnt} = 1; + $hash->{helper}{powerCnt} = 1; #-- initialize these helpers to prepare summarizing of Total of pushed values $hash->{helper}{a_Active_Power}=0; $hash->{helper}{b_Active_Power}=0; @@ -1040,13 +1107,13 @@ sub Shelly_Attr(@) { $hash->{helper}{powerPos} = 0; $hash->{helper}{powerNeg} = 0; - + }elsif( $attrVal eq "shellypmmini" ){ - $hash->{'.AttrList'} =~ s/$attributes{'emeter'}/" Periods:multiple-strict,Week,day,dayT,dayQ,hour,hourQ,min"/e; #allow Periods attribute + $hash->{'.AttrList'} =~ s/$attributes{'emeter'}/" Periods:multiple-strict,Week,day,dayT,dayQ,hour,hourQ,hourT,min"/e; #allow Periods attribute }else{ $hash->{'.AttrList'} =~ s/$attributes{'emeter'}/""/e; } - + if( $shelly_models{$attrVal}[1]==0 ){ #no roller $hash->{'.AttrList'} =~ s/$attributes{'roller'}/""/e; delete $hash->{MOVING}; # ?really necessary? @@ -1057,11 +1124,11 @@ sub Shelly_Attr(@) { $hash->{'.AttrList'} =~ s/$attributes{'showunits'}/" showunits:none,original"/e; # shellyuni measures voltage } - if( $shelly_models{$attrVal}[5] <= 0 ){ #no inputs, but buttons, eg. shellyplug + if( $shelly_models{$attrVal}[5] <= 0 ){ #no inputs, but buttons, eg. shellyplug $hash->{'.AttrList'} =~ s/$attributes{'input'}/""/e; } - - if( $shelly_models{$attrVal}[4] > 0 ){ # Gen 2 devices. Shellyuser is "admin" by default + + if( $shelly_models{$attrVal}[4] > 0 ){ # Gen 2 devices. Shellyuser is "admin" by default $hash->{'.AttrList'} =~ s/shellyuser/""/e; } @@ -1079,69 +1146,68 @@ sub Shelly_Attr(@) { $hash->{'.AttrList'} =~ s/$attributes{'multichannel'}/""/e; } - if( $shelly_models{$attrVal}[4]==0 && $attrVal ne "shellybulb" ){ # 1st Gen + if(0 && $shelly_models{$attrVal}[4]==0 && $attrVal ne "shellybulb" ){ # 1st Gen $hash->{'.AttrList'} =~ s/webhook(\S*?)\s//g; } Log3 $name,5,"[Shelly_Attr] $name ($attrVal) has new attrList \n".$hash->{'.AttrList'}; #5 - - # delete some readings------------------------ + + # delete some readings------------------------ silent if( $attrVal =~ /shelly.*/ ){ #-- only one relay if( $shelly_models{$attrVal}[0] == 1){ - fhem("deletereading $name relay_.*"); - fhem("deletereading $name overpower_.*"); - fhem("deletereading $name button_.*"); + fhem("deletereading $name relay_.*",1); + fhem("deletereading $name overpower_.*",1); + fhem("deletereading $name button_.*",1); #-- no relay }elsif( $shelly_models{$attrVal}[0] == 0){ - fhem("deletereading $name relay.*"); - fhem("deletereading $name overpower.*"); - fhem("deletereading $name button.*"); + fhem("deletereading $name relay.*",1); + fhem("deletereading $name overpower.*",1); + fhem("deletereading $name button.*",1); #-- other number }else{ readingsDelete( $hash, "relay"); - readingsDelete( $hash, "overpower"); + readingsDelete( $hash, "overpower"); readingsDelete( $hash, "button"); } #-- only one roller - if( $shelly_models{$attrVal}[1] == 1){ + if( $shelly_models{$attrVal}[1] == 1){ # fhem("deletereading $name .*_."); # fhem("deletereading $name stop_reason.*"); # fhem("deletereading $name last_dir.*"); # fhem("deletereading $name pct.*"); # delete $hash->{MOVING}; #delete $hash->{DURATION}; - #-- no rollers - }elsif( $shelly_models{$attrVal}[1] == 0){ - fhem("deletereading $name position.*"); - fhem("deletereading $name stop_reason.*"); - fhem("deletereading $name last_dir.*"); - fhem("deletereading $name pct.*"); + #-- no rollers + }elsif( $shelly_models{$attrVal}[1] == 0){ + fhem("deletereading $name position.*",1); + fhem("deletereading $name stop_reason.*",1); + fhem("deletereading $name last_dir.*",1); + fhem("deletereading $name pct.*",1); delete $hash->{MOVING}; delete $hash->{DURATION}; } #-- no dimmers if( $shelly_models{$attrVal}[2] == 0){ - fhem("deletereading $name L-.*"); - fhem("deletereading $name rgb"); - fhem("deletereading $name pct.*"); + fhem("deletereading $name L-.*",1); + fhem("deletereading $name rgb",1); + fhem("deletereading $name pct.*",1); } #-- always clear readings for meters - fhem("deletereading $name power.*"); - fhem("deletereading $name energy.*"); - fhem("deletereading $name overpower.*"); + fhem("deletereading $name power.*",1); + fhem("deletereading $name energy.*",1); + fhem("deletereading $name overpower.*",1); } - # model/ - #--------------------------------------- + #--------------------------------------- }elsif( $cmd eq "set" && $attrName eq "mode" && $init_done == 0 ){ if( $attrVal eq "roller" || $attrVal eq "relay" ){ $hash->{'.AttrList'} =~ s/,white,color//; }elsif( $attrVal eq "white" || $attrVal eq "color" ){ $hash->{'.AttrList'} =~ s/relay,roller,//; } - - #--------------------------------------- + + #--------------------------------------- }elsif( $cmd eq "set" && $attrName eq "mode" && $init_done == 1 ){ # after init, we know the model ! Log3 $name,3,"[Shelly_Attr:mode] $name: setting mode to $attrVal (model is $model)"; if( $model eq "generic" && 0 ){ @@ -1172,10 +1238,10 @@ sub Shelly_Attr(@) { fhem("deletereading $name .*_."); } }else{ - $error="Wrong mode $attrVal for this device, must be relay or roller "; + $error="Wrong mode \'$attrVal\' for this device, must be \'relay\' or \'roller\' "; Log3 $name,1,"[Shelly_Attr] $name\: $error"; return $error; - } + } }elsif( $model eq "shellydimmer" ){ fhem("deletereading $name power.*"); fhem("deletereading $name energy.*"); @@ -1198,27 +1264,28 @@ sub Shelly_Attr(@) { return $error; } } + if( AttrVal($name,"mode","") eq $attrVal ){ + $error="Mode is already set to desired value, aborting"; + Log3 $name,1,"[Shelly_Attr] $name\: $error"; + return $error; + } if( $shelly_models{$model}[4]==0 ){ #1st Gen - Shelly_configure($hash,"settings?mode=$attrVal"); + Shelly_HttpRequest( $hash,"/settings","?mode=$attrVal","Shelly_response","config" ); }else{ #2ndGen %26 = %22 " - Shelly_configure($hash,"rpc/Sys.SetConfig?config={%22device%22:{%22profile%22:$attrVal}}"); + Shelly_HttpRequest( $hash,"/rpc/Sys.SetConfig","?config={%22device%22:{%22profile%22:$attrVal}}","Shelly_response","config" ); } delete $hash->{MOVING} if( $attrVal ne "roller" ); # ?necessary? - # mode/ - - #--------------------------------------- + # mode/ + + #--------------------------------------- }elsif( $attrName =~ /showunits/ ){ if( $cmd eq "set" && $attrVal ne "none" ){ $hash->{units}=1; - }else{ + }else{ # del or set to none $hash->{units}=0; } - - #--------------------------------------- - #}elsif ( $cmd eq "del" && ($attrName =~ /showunits/) ) { - # $hash->{units}=0; - #--------------------------------------- + #--------------------------------------- }elsif( $attrName eq "PeriodsCorr-F" ){ my (@keys,$key,$newkey); if( $cmd eq "del"){ @@ -1252,10 +1319,10 @@ sub Shelly_Attr(@) { $hash->{CORR} = round($attrVal,4); $_[3] = $hash->{CORR}; if(0){ - #------expand the periods-hash & expand the hidden attribute list: + #------expand the periods-hash & expand the hidden attribute list: @keys = keys %periods; - foreach $key ( @keys ){#Debug $key; - if( $key !~ /(_c)$/ ){#Debug $key."-".$periods{$key}[0]; + foreach $key ( @keys ){ + if( $key !~ /(_c)$/ ){ $newkey=$key.'_c'; #if( !exists($periods{$newkey}) ){ unless( AttrVal($name,$attrName,undef) ){ #run only once @@ -1267,13 +1334,14 @@ sub Shelly_Attr(@) { } } } - #--------------------------------------- -# }elsif( $init_done == 0 ){ -# return undef; - - ########## following commands are only passed when init is done ! ############# - - #--------------------------------------- + #--------------------------------------- + }elsif( $init_done == 0 ){ + Log3 $name,5,"[Shelly_Attr Debug]leaving Shelly_Attr for cmd $attrName while init is not finished "; + return undef; + + ########## following commands are only passed when init is done ! ############# + + #--------------------------------------- }elsif( $cmd eq "set" && $attrName eq "maxAge" ){ if ( $attrVal < 60 ){ #interval $error="maxAge must be at least \'interval\', in seconds"; @@ -1281,77 +1349,88 @@ sub Shelly_Attr(@) { return $error; } # maxage/ - #--------------------------------------- - }elsif(0&& ($cmd eq "set" ) && ($attrName =~ /ShellyName/) ) { + #--------------------------------------- + # set the name of the Shelly + }elsif( $cmd eq "set" && $attrName =~ /ShellyName/ ){ #$attrVal="" if( $cmd eq "del" ); #cannot set name to empty string if ( $attrVal =~ " " ){ #spaces not allowed in urls $attrVal =~ s/ /%20/g; - } - if ($shelly_models{$model}[4]==0 ){ #1st Gen - Shelly_configure($hash,"settings?name=$attrVal"); - }else{ - Shelly_configure($hash,"rpc/Sys.SetConfig?config={%22device%22:{%22name%22:%22$attrVal%22}}"); - # {"device" :{" name" :"attrVal"}} } - - #--------------------------------------- - }elsif( ($cmd eq "set" ) && ($attrName =~ /showinputs/) && $attrVal ne "show" ) { + if ($shelly_models{$model}[4]==0 ){ #1st Gen + Shelly_HttpRequest( $hash,"/settings","?name=$attrVal","Shelly_response","config" ); + }else{ + # {"device" :{" name" :"attrVal"}} + Shelly_HttpRequest( $hash,"/rpc/Sys.SetConfig","?config={%22device%22:{%22name%22:%22$attrVal%22}}","Shelly_response","config" ); + } + + #--------------------------------------- + }elsif( $cmd eq "set" && $attrName =~ /showinputs/ && $attrVal ne "show" ){ fhem("deletereading $name input.*"); fhem("deletereading $name button.*"); - - #--------------------------------------- - }elsif( $cmd eq "del" && ($attrName =~ /showinputs/) ) { + + #--------------------------------------- + }elsif( $cmd eq "del" && $attrName =~ /showinputs/ ){ fhem("deletereading $name input.*"); fhem("deletereading $name button.*"); - - #--------------------------------------- + + #--------------------------------------- }elsif( $cmd eq "set" && $attrName eq "maxpower" ){ if( $shelly_models{$model}[3] == 0 ){ $error="Setting the maxpower attribute for this device is not possible"; Log3 $name,1,"[Shelly_Attr] $name\: $error"; return $error; } - if( $attrVal<1 || $attrVal>3500 ){ - $error="Maxpower must be within the range 1...3500 Watt"; + my $power_limit = ($shelly_models{$model}[4]==0?3500:2800); + if( $attrVal<1 || $attrVal>$power_limit ){ + $error="Maxpower must be within the range 1...$power_limit Watt"; # Shelly2: up to 1840 Watt Log3 $name,1,"[Shelly_Attr] $name\: $error"; return $error; } if($shelly_models{$model}[4]==0 ){ #1st Gen - Shelly_configure($hash,"settings?max_power=".$attrVal); + Shelly_HttpRequest( $hash,"/settings","?max_power=$attrVal","Shelly_response","config" ); }elsif( $mode eq "roller" ){ #2ndGen %26 = %22 " - Shelly_configure($hash,"rpc/Cover.SetConfig?id=0&config={%22power_limit%22:$attrVal}"); + Shelly_HttpRequest( $hash,"/rpc/Cover.SetConfig","?id=0&config={%22power_limit%22:$attrVal}","Shelly_response","config" ); + }elsif( $mode eq "relay" ){ #2ndGen %26 = %22 " + Shelly_HttpRequest( $hash,"/rpc/Switch.SetConfig","?id=0&config={%22power_limit%22:$attrVal}","Shelly_response","config" ); + Shelly_HttpRequest( $hash,"/rpc/Switch.SetConfig","?id=1&config={%22power_limit%22:$attrVal}","Shelly_response","config" ); }else{ - Log3 $name,1,"[Shelly_Attr] $name\: have not set $attrVal (L 744)"; + Log3 $name,1,"[Shelly_Attr] $name\: have not set $attrVal"; } - #--------------------------------------- - }elsif( ($cmd eq "set") && ($attrName =~ /maxtime/) ) { + #--------------------------------------- + # Gen1: maxtime only in older firmware + # newer fw: maxtime_open, maxtime_close + }elsif( $cmd eq "set" && $attrName =~ /maxtime/ ){ if( ($shelly_models{$model}[1] == 0 || $mode ne "roller" ) && $init_done ){ $error="Setting the maxtime attribute only works for devices in roller mode"; - Log3 $name,1,"[Shelly_Attr] $name\: $error model=shelly2/2.5/plus2/pro2 and mode=roller"; + Log3 $name,1,"[Shelly_Attr] $name\: $error model=shelly2/2.5/plus2/pro2 and mode=roller"; + return $error; + } + if( $attrVal<1 || $attrVal>300 ){ + $error="Maxtime must be within the range 1...300 Seconds"; + Log3 $name,1,"[Shelly_Attr] $name\: $error"; return $error; } if($shelly_models{$model}[4]==0 ){ #1st Gen - Shelly_configure($hash,"settings/roller/0?$attrName=".int($attrVal)); + # Gen1: using maxtime will set maxtime_open and maxtime_close! + Shelly_HttpRequest( $hash,"/settings/roller/0","?$attrName=".int($attrVal),"Shelly_response","config" ); }else{ #2nd Gen %26 = %22 " - Shelly_configure($hash,"rpc/Cover.SetConfig?id=0&config={%22$attrName%22:$attrVal}"); - # Shelly_configure($hash,"rpc/Cover.SetConfig?id=0&config={%22maxtime_open%22:$attrVal}"); - # Shelly_configure($hash,"rpc/Cover.SetConfig?id=0&config={%22maxtime_close%22:$attrVal}"); - } - - #--------------------------------------- + Shelly_HttpRequest( $hash,"/rpc/Cover.SetConfig","?id=0&config={%22$attrName%22:$attrVal}","Shelly_response","config" ); + } + + #--------------------------------------- }elsif( $cmd eq "set" && $attrName eq "pct100" ){ if( ($shelly_models{$model}[1] == 0 || $mode ne "roller") && $init_done ){ $error="Setting the pct100 attribute only works for devices in roller mode"; - Log3 $name,1,"[Shelly_Attr] $name\: $error model=shelly2/2.5/plus2/pro2 and mode=roller"; ##R + Log3 $name,1,"[Shelly_Attr] $name\: $error model=shelly2/2.5/plus2/pro2 and mode=roller"; return $error; } if($init_done){ # perform an update of the position related readings RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+1, "Shelly_status", $hash); ##ü + InternalTimer(time()+1, "Shelly_status", $hash); } - #--------------------------------------- + #--------------------------------------- }elsif( $attrName =~ /Energymeter/ ){ if($cmd eq "set" ){ if( $model ne "shellypro3em" ){ @@ -1368,20 +1447,20 @@ sub Shelly_Attr(@) { $_[3] = $attrVal - $hash->{helper}{$attrName}; # set the reading to the "actual meter value" readingsSingleUpdate($hash,"Total_$attrName",shelly_energy_fmt($hash,$attrVal,"Wh" ),1); - - #--------------------------------------- + + #--------------------------------------- }elsif( $cmd eq "del" ){ fhem("deletereading $name Total_$attrName"); } - - #--------------------------------------- + + #--------------------------------------- }elsif( ($cmd eq "set" || $cmd eq "del") && ( $attrName eq "EMchannels") ){ if( $model ne "shellypro3em" ){ $error="Setting of the attribute \"$attrName\" only works for ShellyPro3EM "; Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; } - + return undef if($attrVal eq AttrVal($name,"EMchannels","")); fhem("deletereading $name a_.*"); fhem("deletereading $name b_.*"); @@ -1403,9 +1482,9 @@ sub Shelly_Attr(@) { fhem("deletereading $name .*_L."); fhem("deletereading $name .*_calc.*"); fhem("deletereading $name .*_integr.*"); - + ## "Please use a browser refresh to make the readings visible"; - + #--------------------------------------- }elsif( $attrName eq "Balancing" ){ if( $model ne "shellypro3em" && $init_done){ @@ -1413,8 +1492,8 @@ sub Shelly_Attr(@) { Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; } - if( AttrVal($name,"interval",60)>20 && $init_done ){ - $error="For using the \"$attrName\" the interval must not exceed 20 seconds"; + if( AttrVal($name,"interval_power",AttrVal($name,"interval",$defaultINTERVAL))>20 && $init_done ){ # $hash->{INTERVAL} + $error="For using the \"Balancing\" the interval must not exceed 20 seconds"; Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; } @@ -1429,7 +1508,7 @@ sub Shelly_Attr(@) { readingsBulkUpdate($hash,"Total_Energy_T",ReadingsVal($name,"Total_Energymeter_F",AttrVal($name,"Energymeter_F",0)." kWh"),1); readingsEndUpdate($hash,1); } - #--------------------------------------- + #--------------------------------------- }elsif( $attrName eq "Periods" ){ if( $model ne "shellypro3em" && $model ne "shellypmmini" && $init_done ){ $error="Setting of the attribute \"$attrName\" only works for ShellyPro3EM / ShellyPMmini"; @@ -1437,7 +1516,7 @@ sub Shelly_Attr(@) { return $error; } my $RP; # Readings-postfix - my @keys = keys %periods; #"min","hourQ","hour","dayQ","dayT","day","Week" + my @keys = keys %periods; #"min","hourT","hourQ","hour","dayQ","dayT","day","Week" if( $cmd eq "del"){ foreach $RP ( @keys ){ fhem("deletereading $name .*_$RP"); @@ -1450,7 +1529,6 @@ sub Shelly_Attr(@) { my $AV=AttrVal($name,"Periods","").","; foreach $RP ( @keys ){ my $rp=$RP.','; - #Debug "$rp :: $av ::: ".$AV; if( $av !~ /$rp/ && $AV =~ /$rp/){ fhem("deletereading $name .*_$RP"); Log3 $name,1,"[Shelly_Attr] deleted readings $name\:.*_$RP "; @@ -1459,15 +1537,15 @@ sub Shelly_Attr(@) { if( $av =~ /$rp/ && $AV !~ /$rp/ ){ my $energy; my $factor=$energy_units{AttrVal($name,"showunits","none")}[1]; # normalize readings values to "Wh" - my @readings = ("energy"); - if( $model eq "shellypro3em" ){ - @readings = ("Purchased_Energy_S","Returned_Energy_S","Total_Energy_S"); + my @readings = ("energy"); + if( $model eq "shellypro3em" ){ + @readings = ("Purchased_Energy_S","Returned_Energy_S","Total_Energy_S"); push( @readings,"Purchased_Energy_T","Returned_Energy_T","Total_Energy_T" ) if(AttrVal($name,"Balancing",1) == 1); - } + } foreach my $reading ( @readings ){ if( ReadingsVal($name,"$reading\_$RP",undef) ){ Log3 $name,1,"[Shelly_Attr] $name\: reading $reading\_$RP\' already existing!"; - }else{ + }else{ $energy = shelly_energy_fmt($hash,0,"Wh"); $energy.= " ("; $energy.= ReadingsNum($name,$reading,0.0)/$factor; @@ -1481,97 +1559,134 @@ sub Shelly_Attr(@) { }else{ Log3 $name,3,"[Shelly_Attr] no readings deleted"; } - #--------------------------------------- + #--------------------------------------- }elsif( $attrName eq "webhook" ){ - if( $init_done==0 ){ return; #<<<<<<<<<<< calling "check" is done by Shelly_Define() - Log3 $name,3,"[Shelly_Attr:webhook] $name: check webhooks on start of fhem"; - $hash->{CMD}="Check"; - }elsif( $cmd eq "del" ){ - Log3 $name,3,"[Shelly_Attr:webhook] $name: delete all hooks forwarding to this host and name starts with _"; - # Delete all webhooks to fhem - $hash->{CMD}="Delete"; - }else{ #processing set commands, and init is done - Log3 $name,3,"[Shelly_Attr:webhook] $name command is $cmd, attribute webhook old: ".AttrVal($name,"webhook","NoVal")." new: $attrVal"; - if( $shelly_models{$model}[4]==0 && $init_done && $model ne "shellybulb" ){ # only for 2nd-Generation devices - $error="Setting the webhook attribute only works for 2nd-Generation devices"; - Log3 $name,3,"[Shelly_Attr:webhook] device $name is a $model. $error."; - return $error; - }elsif( $attrVal eq "none" ){ - Log3 $name,3,"[Shelly_Attr:webhook] delete all hooks forwarding to this host and name starts with _"; - # Delete all webhooks to fhem - $hash->{CMD}="Delete"; - }elsif(AttrVal($name,"webhook","none") eq $attrVal ){ - Log3 $name,3,"[Shelly_Attr:webhook] the webhook attribute for device $name remains unchanged to $attrVal"; - # no change, do nothing ..., but check - $hash->{CMD}="Check"; - }elsif( AttrVal($name,"webhook","none") eq "none" ){ - Log3 $name,3,"[Shelly_Attr:webhook] the webhook attribute is now $attrVal, create webhooks"; - # Create webhooks - $hash->{CMD}="Create"; - }else{ - Log3 $name,3,"[Shelly_Attr:webhook] changing the webhook attribute for device $name to $attrVal"; - # do an update - $hash->{CMD}="Check"; - } + if( $init_done==1 ){ + if( $cmd eq "del" ){ + Log3 $name,3,"[Shelly_Attr:webhook] $name: deleted attr webhook --> according actions set disabled"; + Shelly_Set($hash,$name,"actions","disable"); + }else{ + Log3 $name,3,"[Shelly_Attr:webhook] $name: changed attr webhook --> updating according actions"; + Shelly_Set($hash,$name,"actions","update"); + } } - if( $hash->{INTERVAL} != 0 ){ - # calling Shelly_webhook() via timer, otherwise settings are not available - Log3 $name,3,"[Shelly_Attr:webhook] we will call Shelly_webhook for device $name, command is ".$hash->{CMD}; - RemoveInternalTimer($hash,"Shelly_webhook"); - InternalTimer(time()+3, "Shelly_webhook", $hash, 0); - } - #--------------------------------------- + return; + #--------------------------------------- }elsif( $attrName eq "interval" ){ if( $cmd eq "set" ){ + if( $attrVal =~ /[\D]/ ){ + $error="The value of \"$attrName\" must be 0 or a positive integer value representing the interval in seconds "; + Log3 $name,1,"[Shelly_Attr] $name\: $error "; + return $error; + }elsif( $attrVal == 0 ){ + readingsSingleUpdate( $hash,"state","disabled",1 ); + } #-- update timer - if( $model eq "shellypro3em" && $attrVal > 0 ){ + if(0&& $model eq "shellypro3em" && $attrVal > 0 ){ # restart the 2nd timer (only when stopped) # adjust the timer to one second after the full minute InternalTimer(int((time()+60)/60)*60+1, "Shelly_shelly", $hash, 1) - if( AttrVal($name,"interval",-1) == 0 ); - - # adjust the 1st timer to 60 + if( AttrVal($name,"interval",-1) == 0 ); + + # adjust the 1st timer to 60 my @teiler=(1,2,3,4,5,6,10,12,15,20,30,60); my @filter = grep { $_ >= $attrVal } @teiler ; $attrVal = ($attrVal >60 ? int($attrVal/60)*60 : $filter[0]); - $_[3] = $attrVal; + $_[3] = $attrVal; } $hash->{INTERVAL} = int($attrVal); }elsif( $cmd eq "del" ){ - $hash->{INTERVAL}=60; + $hash->{INTERVAL}=$defaultINTERVAL; } - if($init_done){ - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+$hash->{INTERVAL}, "Shelly_status", $hash, 0) - if( $hash->{INTERVAL} != 0 ); - } - #--------------------------------------- + if( $init_done ){ ## && $hash->{INTERVAL} != 0 + Shelly_Set($hash,$name,"startTimer"); + } + #--------------------------------------- + }elsif( $attrName eq "interval_power" ){ + #-- update timer for power-readings of ShellyPro3EM + if( $model ne "shellypro3em" ){ + return "wrong model"; + } + if( $attrVal =~ /\D/ || $attrVal == 0 ){ + $error="The value of \"$attrName\" must be a positive integer value representing the power-interval in seconds "; + Log3 $name,1,"[Shelly_Attr] $name\: $error "; + return $error; + } + if(1&& $init_done && $hash->{INTERVAL} != 0 ){ + RemoveInternalTimer($hash,"Shelly_getEMvalues"); + InternalTimer(time()+$attrVal, "Shelly_getEMvalues", $hash); + } + if( $init_done ){ + Shelly_Set($hash,$name,"startTimer"); + } + #--------------------------------------- }elsif( $attrName eq "defchannel" ){ if( ($shelly_models{$model}[0] < 2 && $mode eq "relay") || ($model eq "shellyrgbw" && $mode ne "white") ){ $error="Setting the \'defchannel\' attribute only works for devices with multiple outputs/relays"; Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; } - if( $attrVal =~ /\D/ ){ # checking if there is anything else than a digit + if( $attrVal eq "all" ){ + #.. + }elsif( $attrVal =~ /\D/ ){ # checking if there is anything else than a digit $error="The value of \"$attrName\" must be a positive integer"; Log3 $name,1,"[Shelly_Attr] $name\: $error "; return $error; - } - #--------------------------------------- + } + #--------------------------------------- }elsif( $attrName eq "webCmd" ){ Log3 $name,5,"[Shelly_Attr] $name: webCmd is set to $attrVal"; - #--------------------------------------- + #--------------------------------------- }elsif( $attrName eq "shellyuser" ){ Log3 $name,5,"[Shelly_Attr] $name: shellyuser is set to $attrVal"; + #--------------------------------------- + }elsif( $attrName eq "verbose" ){ + Log3 $name,5,"[Shelly_Attr] $name: verbose level is changed or deleted"; + }elsif( $attrName eq "timeout" ){ + if( $cmd eq 'del' ){ + Log3 $name,3,"[Shelly_Attr] $name: attr timeout is deleted, response time readings will be deleted"; + fhem("deletereading $name /.*",1); #delete process time readings / silent + }else{ + Log3 $name,3,"[Shelly_Attr] $name: attr timeout is set or changed"; + } } - #--------------------------------------- + #--------------------------------------- return undef; } #END# Shelly_Attr ######################################################################################## # -# Shelly_Get - Implements GetFn function +# Shelly_Notify - Implements NotifyFn function +# +# Parameter: hash ("own" device), +# device hash (the device that generates an event) +# +######################################################################################## + +sub Shelly_Notify($$) { + my ($hash,$dev) = @_; + my $name = $hash->{NAME}; + return if($dev->{NAME} ne "global"); + return if(!grep(m/^INITIALIZED|REREADCFG$/, @{$dev->{CHANGED}})); + + my $interval = AttrVal($name,"interval",$defaultINTERVAL); + if( $interval == 0 ){ + # device is disabled (AttrVal get real value, as we are initilized!) + Log3 $name,3,"[Shelly_Notify] $name is disabled (no polling)"; + return; + } + $hash->{INTERVAL} = $interval; # Updates each minute, if not set as attribute + Log3 $name,3,"[Shelly_Notify] $name: starting timer ($interval sec) and calling actions update"; + Shelly_Set($hash,$name,"startTimer"); + Shelly_Set($hash,$name,"actions","update"); + return undef; +} # END Shelly_Notify() + + +######################################################################################## +# +# Shelly_Get - Implements GetFn function # # Parameter hash, argument array # @@ -1579,36 +1694,50 @@ sub Shelly_Attr(@) { sub Shelly_Get ($@) { my ($hash, @a) = @_; - + #-- check syntax my $name = $hash->{NAME}; my $v; - - Log3 $name,6,"[Shelly_Get] receiving command get $name ".$a[1].($a[2]?" ".$a[2]:"") ; - + + Log3 $name,5,"[Shelly_Get] receiving command get $name ".$a[1].($a[2]?" ".$a[2]:"").($a[3]?" ".$a[3]:"") ; + my $model = AttrVal($name,"model","generic"); my $mode = AttrVal($name,"mode",""); - + #-- get version if( $a[1] eq "version") { return "$name.version => $version"; - + + #-- get actions + }elsif($a[1] eq "actions") { + if( $shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest( $hash,"/settings/actions",undef,"Shelly_settings1G" ); + }else{ + Shelly_HttpRequest( $hash,"/rpc/Webhook.List",undef,"Shelly_settings2G","actions" ); + } #-- autodetect model "get model" }elsif($a[1] eq "model") { - $v = Shelly_get_model($hash); -return $v; - + # $v = Shelly_get_model($hash); + # delete $hash->{SHELLY}; + Shelly_HttpRequest( $hash,"/shelly","","Shelly_getModel" ); + #-- current status }elsif($a[1] eq "status") { $v = Shelly_status($hash); - - #-- current status of shelly - }elsif($a[1] eq "shelly_status") { - $v = Shelly_shelly($hash); - - #-- some help on registers + + #-- current settings of shelly + }elsif($a[1] eq "settings" || $a[1] eq "shelly_status") { + if( $shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest( $hash,"/settings",undef,"Shelly_settings1G" ); + }else{ + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetConfig",undef,"Shelly_settings2G","config" ); + } + Log3 $name,1,"[Shelly_Get] Command \'get $name shelly_status\' is deprecated, use \'get $name settings\' instead! " if( $a[1] eq "shelly_status"); + $v = "Done."; + + #-- GET some help on registers }elsif($a[1] eq "registers") { - return "Please get registers of 2nd-Gen devices via Shelly-App or homepage of the Shelly" + return "Please get registers of 2nd-Gen devices via Shelly-App or homepage of the Shelly" if( $shelly_models{$model}[4]>=1 ); # at the moment, we do not handle registers of Gen2-Devices -> ToDo my ($txt,$txt2); if( ($model =~ /shelly2.*/) && ($mode eq "roller") ){ @@ -1616,7 +1745,7 @@ return $v; }elsif( $model eq "shellydimmer" ){ $txt = "light"; }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "white") ){ # but use /settings/light/{}"; - $txt = "bulbw"; + $txt = "bulbw"; $txt2 = "white" if( $model eq "shellyrgbw" ); #some more settings }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "color") ){ $txt = "color"; @@ -1627,12 +1756,12 @@ return $v; } $txt = $shelly_regs{"$txt"}; $txt .= $shelly_regs{"$txt2"} if( defined($txt2) ); - + return $txt."\n\nSet/Get these registers by calling set/get $name config <registername> <value> [<channel>]"; - - #-- configuration register + + #-- GET configuration register }elsif($a[1] eq "config") { - return "Please set/get configuration of 2nd-Gen devices via Shelly-App or homepage of the Shelly" + return "Please set/get configuration of 2nd-Gen devices via Shelly-App or homepage of the Shelly" if( $shelly_models{$model}[4]>=1 ); # at the moment, we do not handle configuration of Gen2-Devices -> ToDo my $reg = $a[2]; my ($val,$chan); @@ -1642,21 +1771,21 @@ return $v; $chan = 0; }elsif( int(@a) == 2 ){ $reg = ""; - $chan = undef; + $chan = undef; }else{ my $msg = "Error: wrong number of parameters"; Log3 $name,1,"[Shelly_Get] ".$msg; return $msg; } - - my $pre = "settings/"; + + my $pre = "/"; if( $reg ne "" ){ if( ($model =~ /shelly2.*/) && ($mode eq "roller") ){ ##R (plus|pro)? $pre .= "roller/0?"; # do not use 'rollers' }elsif( $model eq "shellydimmer" ){ $pre .= "light/0?"; }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "white") ){ - $pre .= "light/$chan?"; # !white + $pre .= "light/$chan?"; # !white }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "color") ){ $pre .= "color/0?"; }elsif( defined($chan)){ @@ -1667,28 +1796,24 @@ return $v; Log3 $name,1,"[Shelly_Get] $name: $msg"; return $msg; } + Shelly_HttpRequest($hash,"/settings",$pre.$reg,"Shelly_response","getconfig"); + return "$a[0] $a[1] $a[2] $a[3]\n\nsee reading \'config\' for result"; - $v = Shelly_configure($hash,$pre.$reg); # will call Shelly_configure() as Non-Blocking-Get - - if(defined($v)) { - return "$a[0] $a[1] => $v"; - }else{ - return "$a[0] $a[1] $a[2] $a[3]\n\nsee reading \'config\' for result"; - } - - #-- else - }else{ + }elsif( $a[1] eq "?" ){ my $newkeys = $shelly_dropdowns{Gets}; ## join(" ", sort keys %gets); $newkeys =~ s/:noArg//g if( $a[1] ne "?"); my $msg = "unknown argument ".$a[1].", choose one of $newkeys"; + Log3 $name,6,"[Shelly_Get] $name: $msg"; + return $msg; + }else{ #anything else + my $msg = "unknown argument ".$a[1]; Log3 $name,5,"[Shelly_Get] $name: $msg"; return $msg; } - return undef; } #END# Shelly_Get - + ######################################################################################## # # Shelly_Set - Implements SetFn function @@ -1701,14 +1826,14 @@ sub Shelly_Set ($@) { my ($hash, @a) = @_; my $name = shift @a; my $cmd = shift @a; my @args=@a; - + my $parameters=( scalar(@a)?" and ".scalar(@a)." parameters: ".join(" ",@a) : ", no parameters" ); - Log3 $name,3,"[Shelly_Set] calling for device $name with command \'$cmd\'$parameters" if($cmd ne "?");#4 - + Log3 $name,4,"[Shelly_Set] calling for device $name with command \'$cmd\'$parameters" if( defined($cmd) && $cmd ne "?");#4 + my $value = shift @a; # 1st parameter $name = $hash->{NAME} if( !defined($name) ); - + #-- when Shelly_Set is called by 'Shelly_Set($hash)' arguments are not handed over, look for an termporarely stored command in internals if( !defined($cmd) ){ if( defined($hash->{CMD}) ){ @@ -1720,70 +1845,96 @@ sub Shelly_Set ($@) { return "no command given, choose one from ".$hash->{helper}{Sets}; } } - + my $model = AttrVal($name,"model","generic"); # formerly: shelly1 my $mode = AttrVal($name,"mode",""); - my ($msg,$channel,$time,$brightness); + my ($msg,$channel,$time,$brightness,$transit); - #-- WEB asking for command list + #-- WEB asking for command list if( $cmd eq "?" ){ my $newkeys; if( !defined($hash->{helper}{Sets}) ){ # all models and generic $newkeys = $shelly_dropdowns{Shelly}; + $newkeys =~ s/config/config:ap_disable,ap_enable/ if( $shelly_models{$model}[4]>=1 ); + # Gen2 devices only + $newkeys .= $shelly_dropdowns{Actions} + if( $shelly_models{$model}[4]>-1 ); ## all Gens # most of devices, except roller, metering - $newkeys .= $shelly_dropdowns{Onoff} + $newkeys .= $shelly_dropdowns{Onoff} if( ($mode ne "roller" && $shelly_models{$model}[0]>0) || $shelly_models{$model}[2]>0 || $shelly_models{$model}[7]>0 ); # multichannel devices $newkeys .= $shelly_dropdowns{Multi} if( ($mode ne "roller" && $shelly_models{$model}[0]>1) || ($shelly_models{$model}[2]>1 && $mode eq "white") ); if( $mode eq "roller" || ($shelly_models{$model}[0]==0 && $shelly_models{$model}[1]>0)){ $newkeys .= $shelly_dropdowns{Rol}; - }elsif( $model =~ /shellydimmer/ || ($model =~ /shellyrgbw.*/ && $mode eq "white") ){ + }elsif( $shelly_models{$model}[2] > 0 && $mode ne 'color' ){ + #$model =~ /shellydimmer/ || ($model =~ /shellyrgbw.*/ && $mode eq "white") || $model eq "shellyplus010v" ){ $newkeys .= $shelly_dropdowns{RgbwW}; + $newkeys .= " calibrate:noArg" if( $model =~ /shellydimmer/ ); + $newkeys .= " minmaxbrightness btn_fade_rate:1,2,3,4,5 transition_duration:slider,0.5,0.1,5 min_brightness_on_toggle" + if(0 && $model =~ /shellyplus010v/ ); # uzsuDropDown }elsif( $model =~ /shellybulb.*/ && $mode eq "white" ){ $newkeys .= " dim-for-timer".$shelly_dropdowns{BulbW}; + foreach my $cmd ( 'on','off','toggle' ){ + $newkeys =~ s/$cmd /$cmd:noArg /g; + } }elsif( $model =~ /shelly(rgbw|bulb).*/ && $mode eq "color" ){ $newkeys .= $shelly_dropdowns{RgbwC}; + }elsif( $shelly_models{$model}[5]==1 ){ # devices with one input only + $newkeys .= $shelly_dropdowns{Input}; } if( $shelly_models{$model}[4]==0 || $shelly_models{$model}[3]==0 ){ $newkeys =~ s/,energy//; # remove 'energy' from dropdown-list } + if( $shelly_models{$model}[2] == 1 ){ # one channel only, eg 'shellyplus010v' + $newkeys =~ s/on /on:noArg /; + $newkeys =~ s/off /off:noArg /; + $newkeys =~ s/toggle /toggle:noArg /; + } if( $init_done ){ $hash->{helper}{Sets}=$newkeys; - Log3 $name,2,"[Shelly_Set] stored keys for device $name \"$newkeys\" in helper"; + Log3 $name,5,"[Shelly_Set] stored keys for device $name \"$newkeys\" in helper"; } }else{ $newkeys = $hash->{helper}{Sets}; } - - Log3 $name,5,"[Shelly_Set] FhemWeb is requesting set-commands for device $name"; #4 + + Log3 $name,6,"[Shelly_Set] FhemWeb is requesting set-commands for device $name"; #4 #$hash->{'.FWR'}=$hash->{'.FWR'}+1; # ':noArg' will be stripped off by calling instance - return "$model $mode: unknown argument $cmd choose one of $newkeys"; - } - + + return SetExtensions($hash,$hash->{helper}{Sets},$name,$cmd,@args); + } # set ... ? + #-- following commands do not occur in command list, eg. out_on, input_on, single_push - #-- command received via web to register local changes of the device + #-- command received via web to register local changes of the device if( $cmd =~ /^(out|button|input|short|single|double|triple|long|touch|voltage|temperature|humidity|Active_Power|Voltage|Current)_(on|off|push|up|down|multi|over|under|a|b|c|changed)/ - || $cmd =~ /^(stopped|opening|closing|is_open|is_closed|power|voltage|current|tempC)/ ){ + || $cmd =~ /^(stopped|opening|closing|is_open|is_closed|power|voltage|current|tempC|humidity|illuminance|illumination)/ ){ my $signal=$1; my $isWhat=$2; my $subs; - Log3 $name,5,"[Shelly_Set] calling for device $name with command $cmd".( defined($value)?" and channel $value":", without channel" ); - Log3 $name,4,"[Shelly_Set] Calling $name with $cmd val=$value signal=$signal ".(defined($isWhat)?"iswhat=$isWhat":"isWhat not defined"); + Log3 $name,6,"[Shelly_Set] calling for device $name with command $cmd".( defined($value)?" and channel $value":", without channel" ). + (defined($isWhat)?", iswhat=$isWhat":", isWhat not defined"); #6 readingsBeginUpdate($hash); - if( $signal eq "out" && $mode eq "relay"){ #change of device output - $subs = ($shelly_models{$model}[0] == 1) ? "" : "_".$value; - readingsBulkUpdateMonitored($hash,"relay$subs",$isWhat); - readingsBulkUpdateMonitored($hash,"state",$isWhat) - if( $shelly_models{$model}[0]==1 ); ## do not set state on multichannel-devices - }elsif( $signal eq "out" && $mode eq "white"){ #change of bulb device output - $subs = ($shelly_models{$model}[2] == 1) ? "" : "_".$value; # no of dimmers - readingsBulkUpdateMonitored($hash,"state$subs",$isWhat); - }elsif( $signal eq "out" && !$value ){ #change of single channel device output - #$subs = ""; + if( $cmd =~ /^(out)/ ){ + my $channels = maxNum($shelly_models{$model}[0],$shelly_models{$model}[2]); # device has one or more relay or dimmer - channels + $channels = 1 if( !$value ); #no channel given - change of single channel device output + + if( $cmd !~ /(on|off)$/ ){ + Shelly_error_handling($hash,"Shelly_Set:out","No handler for command <$cmd>",1); + }elsif( $channels == 1 ){ # single channel device + readingsBulkUpdateMonitored($hash,"relay",$isWhat) if( $shelly_models{$model}[0] > 0 ); # a relay device readingsBulkUpdateMonitored($hash,"state",$isWhat); + }elsif( $value =~ /\D/ || $value >= $channels ){ # check if channel is anything else than a digit or wrong number + Shelly_error_handling($hash,"Shelly_Set:out","Wrong channel <$value> for command <$cmd>",1); + }elsif( $shelly_models{$model}[0] > 1 ){ + readingsBulkUpdateMonitored($hash,"relay_$value",$isWhat); + }elsif( $shelly_models{$model}[2] > 1 ){ + readingsBulkUpdateMonitored($hash,"state_$value",$isWhat); + }else{ + Shelly_error_handling($hash,"Shelly_Set:out","no handler for command <$cmd>",1); + } }elsif( $signal eq "button" ){ # ShellyPlug(S) $subs = ($shelly_models{$model}[5] == -1) ? "" : "_".$value; readingsBulkUpdateMonitored($hash, "button$subs", $isWhat, 1 ); @@ -1795,40 +1946,81 @@ sub Shelly_Set ($@) { readingsBulkUpdateMonitored($hash, "input$subs", "ON", 1 ); readingsBulkUpdateMonitored($hash, "input$subs\_action", $cmd, 1 ); readingsBulkUpdateMonitored($hash, "input$subs\_actionS",$fhem_events{$cmd}, 1 ); - # after a second, the pushbuttons state is back to OFF resp. 'unknown', call status of inputs - RemoveInternalTimer($hash,"Shelly_inputstatus"); - InternalTimer(time()+1.4, "Shelly_inputstatus", $hash,1); + # Note: after a second, the pushbuttons state is back to OFF resp. 'unknown', call status of inputs + RemoveInternalTimer($hash,"Shelly_status"); + InternalTimer(time()+1.4, "Shelly_status", $hash); }elsif( $signal eq "touch" ){ # devices with an touch-display #$subs = ($shelly_models{$model}[5] == 1) ? "" : "_".$value; readingsBulkUpdateMonitored($hash, "touch", $isWhat, 1 ); - }elsif( $signal =~ /^(voltage|temperature|humidity)/ ){ + }elsif( $signal =~ /(over|under)/ ){ $subs = defined($value)?"_".$value:"" ; readingsBulkUpdateMonitored($hash,$signal.$subs."_range", $isWhat ); }elsif( $signal =~ /^(tempC)/ ){ - $subs = defined($value)?"_".$a[0]:"" ; + $subs = defined($a[0])?"_".$a[0]:"" ; readingsBulkUpdateMonitored($hash,"temperature".$subs, $value.$si_units{tempC}[$hash->{units}] ); - }elsif( $signal =~ /^(power|voltage|current)/ ){ #as by ShellyPMmini - $value = sprintf( "%5.2f%s", $value, $si_units{$signal}[$hash->{units}] ); ## %5.1f - readingsBulkUpdateMonitored($hash,$signal,$value ); + }elsif( $signal =~ /^(Xtemperature|Xhumidity|illuminance|illumination)/ ){ + $subs = defined($a[0])?"_".$a[0]:"" ; + if( $signal eq "illumination" && ReadingsAge($name,"illuminance".$subs,0) > 2.5 ){ # to cover a bug in Shellies fw (no $ev.illuminance known) + # readingsBulkUpdateMonitored($hash,"illuminance".$subs, "-" ); + Shelly_status($hash); + }else{ + readingsBulkUpdateMonitored($hash,$signal.$subs, $value.$si_units{$signal}[$hash->{units}] ); + } + }elsif( $cmd =~ /^(power|voltage|current|temperature|humidity)/ ){ #as by ShellyPMmini, ShellyUni, ... + + my $channels = $shelly_models{$model}[3]; # number of metering channels + $channels = 1 if( $model =~ /uni/ ); # ShellyUni or ShellyPlusUni + $channels = 1 if( $model =~ /display/ && $cmd =~ /^(temperature|humidity)/ ); # + $channels = 10 if( ReadingsVal($name,"addon","none") eq "sensor" ); # + my $channel; + if( $cmd =~ /(over|under)$/ ){ # channel is given as $value + $channel = $value; + $channel = 0 if( !defined($channel) ); + if( $channel =~ /\D/ || $channel >= $channels ){ # check if channel is anything else than a digit or wrong number + Shelly_error_handling($hash,"Shelly_Set","Wrong channel <$value> for command <$cmd>",1); + }else{ + $subs = $channels>1?"_".$channel:"" ; + readingsBulkUpdateMonitored($hash,$signal.$subs."_range", $isWhat ); + } + }else{ # channel is given as next parameter + $channel = $a[0]; + if( !defined($channel) ){ + if( $channels > 1){ + Shelly_error_handling($hash,"Shelly_Set","No channel given for command <$cmd>",1); + return; + }else{ + $channel = 0; + } + } + if( $channel =~ /\D/ || $channel >= $channels ){ # check if channel is anything else than a digit or wrong number + Shelly_error_handling($hash,"Shelly_Set","Wrong channel <$channel> for command <$cmd>",1); + }elsif( $value !~ /[0-9.]/ ){ # check if value is a number + Shelly_error_handling($hash,"Shelly_Set","Wrong value <$value> for command <$cmd>",1); + }else{ + $subs = $channels>1?"_".$channel:"" ; + $value = sprintf( "%5.2f%s", $value, $si_units{$signal}[$hash->{units}] ); ## %5.1f + readingsBulkUpdateMonitored($hash,$signal.$subs,$value ); + } + } }elsif( $signal =~ /^(Active_Power|Voltage|Current)/ ){ if( !defined($isWhat) ){ - Shelly_error_handling($hash,"Shelly_Set:Active_Power","no phase received from ShellyPro3EM"); + Shelly_error_handling($hash,"Shelly_Set:Active_Power","no phase received from ShellyPro3EM",2); return; } - my $suffix = AttrVal($name,"EMchannels","_ABC"); + my $suffix = AttrVal($name,"EMchannels","_ABC"); my $reading; $reading = $mapping{pr}{$suffix}{$isWhat.'_'} . $signal; $reading .='_pushed' if( $signal eq "Active_Power" ); - $reading .= $mapping{ps}{$suffix}{$isWhat.'_'}; + $reading .= $mapping{ps}{$suffix}{$isWhat.'_'}; if( $signal eq "Active_Power" ){ # save pushed active power value of a single phase for later calculation of total value # these values are overwritten by regular updates @ interval $hash->{helper}{"$isWhat\_Active_Power"}=$value; - + $value = sprintf( "%5.1f%s", $value, $si_units{power}[$hash->{units}] ); readingsBulkUpdateMonitored($hash,$reading,$value ); - - $reading = $mapping{pr}{$suffix}{'total_'} . "Active_Power_pushed" . $mapping{ps}{$suffix}{'total_'}; + + $reading = $mapping{pr}{$suffix}{'total_'} . "Active_Power_pushed" . $mapping{ps}{$suffix}{'total_'}; # calculate total value out of pushed and regular values $value = $hash->{helper}{a_Active_Power}+$hash->{helper}{b_Active_Power}+$hash->{helper}{c_Active_Power}; $value = sprintf("%5.1f%s", $value, $si_units{power}[$hash->{units}] ); @@ -1853,64 +2045,211 @@ sub Shelly_Set ($@) { } readingsBulkUpdateMonitored($hash,"state",$hash->{MOVING}) if( defined($hash->{MOVING}) ); readingsEndUpdate($hash,1); - #-- Call status after switch.n - if( $signal !~ /^(Active_Power|Voltage|Current|apower|voltage|current)/ ){ - RemoveInternalTimer($hash,"Shelly_status"); Log3 $name,6,"shelly_set 1715 removed Timer Shelly_status, now calling in 1.5 sec"; - InternalTimer(time()+1.5, "Shelly_status", $hash); + #-- Call status after switch.n +if(0){ + if( $signal !~ /^(Active_Power|Voltage|Current|apower|voltage|current)/ ){ + RemoveInternalTimer($hash,"Shelly_status"); Log3 $name,5,"[shelly_set] removed Timer Shelly_status, now calling in 0.75 sec"; + InternalTimer(time()+0.75, "Shelly_status", $hash); } +} return undef; + #--------------------------- + }elsif( $cmd =~ /actions/ ){ + Log3 $name,4,"[Shelly_Set:actions] $name: \'set $cmd\' called"; + #--------------------------- + # set actions create info||all + # set actions delete |own|all + # set actions disable + # set actions enable + # set actions update + my $actioncmd = $value; + my $actionselect = shift @a; + my $actionchannel = shift @a; + $actionselect = "" if( !defined($actionselect) ); + $actionselect = "info" if( $actioncmd eq "y" ); # for debugging only + Log3 $name,4,"[Shelly_Set:actions] $name: \'set $cmd $actioncmd $actionselect\' called"; + my $gen=$shelly_models{$model}[4]; + #-- check parameter + if( $actioncmd eq "y" ){ #ok + }elsif( $actioncmd !~ /create|delete|disable|enable|update|y/ ){ + return "Command \'$actioncmd\' is not valid"; + }elsif( $actioncmd !~ /create|enable/ && ReadingsNum($name,"webhook_cnt",0)==0 ){ + return "No enabled actions on device $name"; + }elsif( $actioncmd =~ /update/ ){ + return "Please define attr webhook first" if( !defined(AttrVal($name,"webhook",undef)) ); + } + if( $gen == 0 ){ + $actionchannel=0 unless( defined($actionchannel) ); + }else{ + if( $actionselect eq "own" || $actionselect eq "all" || $actionselect eq "info" ){ #ok + }elsif( $actionselect =~ /\D/ ){ # has non-digits, or minus-sign + ## Debug "Parameter is negative or not numerical"; + return "Parameter is negative or not numerical"; + }elsif( $actionselect eq "" && $actioncmd ne "create" && $actioncmd ne "update" && $actioncmd ne "y" ){ + ## Debug "No id given"; + return "No id given"; + }elsif( $actionselect ne "" && $actionselect < 0 ){ # some case 0 not valid + ## Debug "Id \'$actionselect\' is not valid"; + return "Id \'$actionselect\' is not valid"; + }else{ + ## Debug "$name: actionselect=$actionselect"; + } + } + # when using a not existing id, shelly will return 'Not Found', reading error will be set to '-105...hook_id...not found!' + #-- perform commands + if( $actioncmd eq "enable" ){ + if( $gen==0 ){ + Shelly_HttpRequest( $hash,"/settings/actions","?index=$actionchannel&name=$actionselect&enabled=true","Shelly_settings1G","webhook_update" ); + }else{ + Shelly_HttpRequest( $hash,"/rpc/Webhook.Update","?id=$actionselect&enable=true","Shelly_settings2G","webhook_update" ); + } + }elsif( $actioncmd eq "disable"){ + if( $gen==0 ){ + Shelly_HttpRequest( $hash,"/settings/actions","?index=$actionchannel&name=$actionselect&enabled=false","Shelly_settings1G","webhook_update" ); + }else{ + Shelly_HttpRequest( $hash,"/rpc/Webhook.Update","?id=$actionselect&enable=false","Shelly_settings2G","webhook_update" ); + } + }elsif( $actioncmd eq "delete" ){ + if( $gen==0 ){ + Shelly_HttpRequest( $hash,"/settings/actions", + "?index=$actionchannel&name=$actionselect&enabled=false&urls[]=\"\"", "Shelly_settings1G","webhook_update" ); + }else{ + if( $actionselect eq "all" ){ + Shelly_HttpRequest( $hash,"/rpc/Webhook.DeleteAll","","Shelly_settings2G","webhook_update" ); + }elsif( $actionselect eq "own" ){ + return "Command not implemented yet"; + }else{ + Shelly_HttpRequest( $hash,"/rpc/Webhook.Delete","?id=$actionselect","Shelly_settings2G","webhook_update" ); + } + } + }elsif( $actioncmd eq "create" ){ + if( $gen==0 && $actionselect eq "info" ){ + + Shelly_HttpRequest( $hash,"/settings/actions",undef,"Shelly_settings1G",undef,2 ); # we use the 'val' parameter to get the call as $info + + }elsif( !AttrVal($name,"webhook",undef) && $actionselect ne "info" ){ + return "please define attribute webhook first"; + }else{ + return Shelly_webhook_create($hash,$actionselect); + } + }elsif( $actioncmd eq "update"){ + if( $gen==0 ){ + Shelly_HttpRequest( $hash,"/settings/actions",undef,"Shelly_webhook_update",$actionselect ); + }else{ + Shelly_HttpRequest( $hash,"/rpc/Webhook.List",undef,"Shelly_webhook_update",$actionselect ); + } + } + return; + #--------------------------- } - - #-- real commands + + #-- real commands my $ff=-1; # Function-Family, correspondends to row in %shelly_models{model}[] - + #-- we have a switch type device - if( $shelly_models{$model}[0]>0 && $mode ne "roller" ){ + if( $shelly_models{$model}[0]>0 && $mode ne 'roller' ){ $ff = 0; #-- we have a Shelly 2 / 2.5 or a Shelly(Plus/Pro)2pm roller type device - }elsif( $shelly_models{$model}[1]>0 && $mode ne "relay" ){ + }elsif( $shelly_models{$model}[1]>0 && $mode ne 'relay' ){ $ff = 1; #-- we have a dimable device: Shelly dimmer or Shelly RGBW in white mode - }elsif( ($model =~ /shellydimmer/) || (($model =~ /shellyrgbw.*/) && ($mode eq "white")) ){ + }elsif( $shelly_models{$model}[2]>0 && $mode ne 'color' ){ + # $model =~ /shellydimmer/ || ($model =~ /shellyrgbw.*/ && $mode eq 'white') || $model eq 'shellyplus010v' ){ $ff = 2; #-- we have a ShellyBulbDuo - }elsif( ($model =~ /shellybulb.*/) && ($mode eq "white") ){ + }elsif( $model =~ /shellybulb.*/ && $mode eq 'white' ){ $ff = 2; #-- we have a color type device (Bulb or Shelly RGBW, and color mode) - }elsif( ($model =~ /shelly(rgbw|bulb).*/) && ($mode eq "color")){ + }elsif( ($model =~ /shelly(rgbw|bulb).*/) && ($mode eq 'color')){ $ff = 7; }else{ $ff = -1; - } + } #-- get channel parameter + $msg = ""; if( $cmd eq "toggle" || $cmd eq "on" || $cmd eq "off" ){ - $channel = $value; + $channel = $value; }elsif( $cmd =~ /(dimup)|(dimdown)/ ){ - my $delta = $value; - $channel = shift @a; - $channel = AttrVal($name,"defchannel",0) if( !defined($channel) ); - my $subs = $shelly_models{$model}[2]>1 ? "_$channel" : ""; - if( !defined($delta) ){ - $delta = AttrVal($name,"dimstep",25); + # commands for single channel devices or if attr defchannel is set + # set dimup + # set dimup delta + # set dimup delta:transit + # commands for multi channel devices and attr defchannel is not set + # set dimup channel + # set dimup delta channel + # set dimup delta:transit channel + + #channel + my $subs; + my $delta; + if( $shelly_models{$model}[2]==1 ){ + $channel = 0; + $subs = ""; + $delta = $value; + $delta = AttrVal($name,"dimstep",25) if( !defined($value) ); + }elsif( $shelly_models{$model}[2]<1 ){ + return "invalid command"; + }elsif( defined(AttrVal($name,"defchannel",undef)) ){ + $channel = AttrVal($name,"defchannel",undef); + $subs = "_$channel"; + }elsif( scalar(@a) == 1 ){ + $channel = shift @a; + return "channel not numerical" if( $channel =~ /\D/ ); + $subs = "_$channel"; + $delta = $value; + }elsif( defined($value) ){ + $channel = $value; + return "channel not numerical" if( $channel =~ /\D/ ); + $subs = "_$channel"; + $delta = AttrVal($name,"dimstep",25); + }else{ + return "channel not given and attr defchannel not defined properly"; + } + #transition time + if( $delta =~ /:/ ){ + $delta =~ m/(.*):(.*)/; + $delta = $1; + $transit=$2; + Debug "$1 - $2"; + return "brightness-difference not given or not numerical" if( $delta =~ /\D/ ); + return "transit duration not given or not numerical" if( $transit !~ /[\d.]/ ); + return "transit duration must not exceed 5 sec" if( $transit>5 && ReadingsVal($name,"model_family","-") eq "Gen1" ); + $transit = int(1000*$transit); + $msg = ", duration is $transit msec"; } $delta = -$delta if( $cmd eq "dimdown" ); + $msg = "Desired delta of brightness is $delta$msg"; + #resulting brightness + $cmd = "dim"; $brightness = ReadingsNum($name,"pct$subs",0) + $delta; - $brightness = 100 if( $brightness > 100 ); - if( $brightness < 10 ){ + if( $brightness > 100 ){ + $brightness = 100; + }elsif( $brightness < 10 ){ + $brightness = 0; $cmd = "off"; - }else{ - $cmd = "dim"; } + $msg .= ", setting brightness of channel \'$channel\' to \'$brightness\'"; + $msg .= ", using comand $cmd"; + Log3 $name,4,"[Shelly_Set:dimupdown] ".$msg;#return $msg; }elsif( $cmd =~ /(on|off)-for-timer/ ){ $time = $value; $channel = shift @a; }elsif( $cmd =~ /dim/ ){ - $brightness = $value; - if( $brightness > 100 ){ + if( $value =~ m/(\d*):(\d*)/ ){ + $brightness = $1; + $transit=$2; + $brightness = undef if( $1 eq "" ); + return "transit duration not given or not numerical" if( $2 eq "" ); + }else{ + return "brightness not numerical" if( $value =~ /\D/ ); + $brightness = $value; + } + return "brightness not given" if( !defined($brightness) ); + if( $brightness > 100 ){ $msg = "given brightness \'$brightness\' to high for device $name, must not exceed 100"; - Log3 $name,1,"[Shelly_Set] ".$msg; + Log3 $name,1,"[Shelly_Set] ".$msg; return $msg; } $time = shift @a if( $cmd =~ /dim-for-timer/ ); @@ -1918,9 +2257,16 @@ sub Shelly_Set ($@) { }elsif( ($cmd eq "pct" && $ff!=1 ) || $cmd =~ /dim/ || $cmd eq "brightness" || $cmd eq "ct" ){ # $pct = $value; $channel = shift @a; - $channel = shift @a if( $channel eq "%" ); # skip %-sign coming from dropdown (units=1) - } - + $channel = shift @a if( defined($channel) && $channel eq "%" ); # skip %-sign coming from dropdown (units=1) + } + + #****** map on and off commands to ON, OFF + if( $cmd =~ /^((on)|(off))/ && !defined($channel) && AttrVal($name,"defchannel","undefined") eq "all" ){ + $cmd = uc($1); + Log3 $name,3,"[Shelly_Set] command \'$1\' mapped to switch all channels"; + } + + #****** #-- check channel if( $cmd =~ /^(toggle|on|off|pct|dim|brightness)/ && $cmd!~/(till)/ && $ff != 1){ # not for rollers if( $ff != 0 && $ff !=2 && $ff !=7 ){ @@ -1935,9 +2281,6 @@ sub Shelly_Set ($@) { Log3 $name,1,"[Shelly_Set] ".$msg; return $msg; } - $msg = (defined($channel))?$channel:"undefined"; - Log3 $name,4,"[Shelly_Set] $name precheck: channel is $msg"; - if( !defined($channel) ){ if( $shelly_models{$model}[$ff] > 1 ){ $msg = "$name Error: no channel given and defchannel attribute not set properly"; @@ -1953,10 +2296,26 @@ sub Shelly_Set ($@) { Log3 $name,1,"[Shelly_Set] $msg"; return $msg; } + Log3 $name,4,"[Shelly_Set] $name channel is $channel"; } + #-- do not loose existing 'on' timer on retrigger + my $oldtimer; + my $tmr = defined($channel) ? "timer_$channel" : "timer"; + $msg = "[Shelly_Set] $name \'$tmr\': "; + $oldtimer = ReadingsNum( $name, $tmr, ReadingsNum( $name, "timer", 0 ) ); + if( $oldtimer > 0 && $cmd !~ /off/ ){ + $oldtimer -= ReadingsAge( $name, $tmr, ReadingsAge( $name, "timer", 0 ) ); + $oldtimer = "&timer=$oldtimer"; + $msg .= "adding remaining timer \'$oldtimer\' to command $cmd"; + }else{ + $msg .= "no timer to add to $cmd"; + $oldtimer = ""; + } + Log3 $name,5,$msg; + #-- transfer toggle command to an on-off-command - if( $cmd eq "toggle" ){ # && $shelly_models{$model}[0]<2 && $shelly_models{$model}[2]<2 ){ #select devices with less than 2 channels + if( $cmd eq "toggle" ){ # && $shelly_models{$model}[0]<2 && $shelly_models{$model}[2]<2 ){ #select devices with less than 2 channels if( ($shelly_models{$model}[0]>1 && $mode ne "roller") || ($shelly_models{$model}[2]>1 && $mode eq "white") ){ # we have a multi-channel device # toggle named channel of switch type device or RGBW-device @@ -1973,11 +2332,11 @@ sub Shelly_Set ($@) { #- - on and off, on-for-timer and off-for-timer if( $cmd =~ /^((on)|(off)|(dim))/ && $cmd!~/(till)/ ){ # on-till, on-till-overnight if( $cmd eq "dim" ){ - # - if( $brightness == 0 ){ - $cmd = "?turn=off"; + # + if( $brightness == 0 ){ + $cmd = "?turn=off$oldtimer"; }else{ - $cmd = "?brightness=$brightness&turn=on"; + $cmd = "?brightness=$brightness&turn=on$oldtimer"; } } #-- check timer command @@ -1989,7 +2348,7 @@ sub Shelly_Set ($@) { return $msg; }elsif( $time > 100000000 ){ # more than three years $msg = "given time to high for device $name, must be less than one year"; - Log3 $name,1,"[Shelly_Set] ".$msg; + Log3 $name,1,"[Shelly_Set] ".$msg; return $msg; }elsif( $time < 1){ # to low $msg = "given time to low for device $name"; @@ -2003,39 +2362,50 @@ sub Shelly_Set ($@) { }elsif( $cmd eq "off-for-timer" ){ $cmd = "?turn=off&timer=$time"; } + $hash->{helper}{timer} = $time; # cannot read out timer in latest fw eg walldisplay }elsif( $cmd =~ /(on)|(off)/ ){ - $cmd = "?turn=$cmd"; - } + $cmd = "?turn=$cmd$oldtimer"; + } # $cmd = is 'on' or 'off' or 'on&timer=...' or 'off&timer=....' or 'dim&timer=....' + $cmd .="&transition=$transit" if( $transit ); + Log3 $name,4,"[Shelly_Set] switching channel $channel for device $name with command $cmd, FF=$ff";#4 - if( $ff==0 ){ - if( $shelly_models{$model}[4]==2 ){ -## $cmd = "?turn=$cmd" ##"/relay/$channel?turn=$cmd"; -## if( $cmd !~ "brightness" ); -## }else{ - $cmd =~ s/\?turn=on/true/; - $cmd =~ s/\?turn=off/false/; + my $comp; + if( $shelly_models{$model}[4]==2 ){ #Gen2 + # translate Gen1-commands to Gen2 + $cmd =~ s/\?/\&/g; + $cmd =~ s/turn=on/on=true/; + $cmd =~ s/turn=off/on=false/; $cmd =~ s/timer/toggle_after/; - $cmd = "/rpc/Switch.Set?id=$channel&on=$cmd"; + $cmd =~ s/transition/transition_duration/; + if( $ff==0 ){ + $comp = "Switch"; + }elsif( $ff==2 ){ + $comp = "Light"; + }elsif( $ff==7 ){ + # tbd } - $msg = Shelly_onoff($hash,$channel,$cmd); - }elsif( $ff==2 ){ - if( $model =~ /shellydimmer/ ){ - $channel = "light/$channel"; - }elsif( $model =~ /shellybulb/ && $mode eq "white" ){ - $channel = "light/$channel"; - }elsif( $model =~ /shellyrgbw/ && $mode eq "white" ){ - $channel = "white/$channel"; + # $cmd .="&transition_duration=$transit" if( $transit ); + Shelly_HttpRequest($hash,"/rpc/$comp.Set", "?id=$channel$cmd","Shelly_response","onoff"); #RONOFF + }else{ #Gen1 + if( $ff==0 ){ + $comp = "relay"; + }elsif( $ff==2 || $ff==7 ){ + if( $model =~ /shellydimmer/ ){ + $comp = "light"; + }elsif( $model =~ /shellybulb/ && $mode eq "white" ){ + $comp = "light"; + }elsif( $model =~ /shellyrgbw/ && $mode eq "white" ){ + $comp = "white"; + }else{ # ff==7: RGBW or Bulb in color mode + $comp = "color"; + } } - # - $msg = Shelly_dim($hash,$channel,$cmd); - }elsif($ff==7 ){ - $msg = Shelly_dim($hash,"color/$channel",$cmd); #"?turn=$cmd" + Shelly_HttpRequest($hash,"/$comp","/$channel$cmd","Shelly_response","onoff"); # dim=onoff and more } - return $msg if( $msg ); return; - + #- - ON and OFF - switch all channels of a multichannel switch-device }elsif( $cmd =~ /^((ON)|(OFF))/ ){ $cmd = lc($1); @@ -2044,72 +2414,79 @@ sub Shelly_Set ($@) { } return; } - - #- - pct, brightness, dim - set percentage volume of dimmable device (no rollers) eg. shellydimmer or shellyrgbw in white mode - if( ($cmd eq "pct" || $cmd eq "brightness" || $cmd =~ /^(dim)/ ) && $ff != 1 ){ - if( $ff !=2 ){ - $msg = "Error: forbidden command \'$cmd\' for device $name <$ff>"; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - } - # check value - if( !defined($value) && $cmd =~ /up|down/ ){ - $value = AttrVal($name,"dimstep",10) if(!defined($value)); - }elsif( !defined($value) ){ - $msg = "Error: no $cmd value \'$value\' given for device $name"; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - }elsif( $value =~ /\D+/ ){ #anything else than a digit - $msg = "Error: wrong $cmd value \'$value\' for device $name, must be "; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - }elsif( $value == 0 && $cmd =~ /(pct)|(dimup)|(dimdown)/ ){ - $msg = "$name Error: wrong $cmd value \'$value\' given, must be 1 ... 100 "; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - }elsif( $value<0 || $value>100 ){ - $msg = "$name Error: wrong $cmd value \'$value\' given, must be 0 ... 100 "; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - } - #$cmd = "?brightness=".$value; - Log3 $name,4,"[Shelly_Set] setting brightness for device $name to $value"; - if( $ff==2 ){ - if( $model =~ /shellyrgbw/ && $mode eq "white" ){ - $channel = "white/$channel"; - }else{ - $channel = "light/$channel"; - } - if( $value == 0 ){ # dim-command - $cmd="?turn=off" ; - }elsif($cmd eq "pct" ){ - $cmd="?brightness=$value"; - }elsif($cmd =~ /dim(up|down)/ ){ - $cmd="?dim=$1"."\&step=$value"; - }else{ - $cmd="?brightness=$value\&turn=on"; - } - return Shelly_dim($hash,$channel,$cmd); - } - return $msg if( $msg ); - } #-- commands strongly dependent on Shelly type ------------------------------------------------------- + $msg=undef; + ################################################################################################################ + # we have a dimmable device (no rollers) eg. shellydimmer or shellyrgbw in white mode: set percentage volume + if( $ff==2 && $cmd =~ /^(pct|brightness|dim)/ ){ + # check value + if( !defined($value) && $cmd =~ /up|down/ ){ + $value = AttrVal($name,"dimstep",10); + } + if( !defined($value) ){ + $msg = "Error: no $cmd value \'$value\' given for device $name"; + }elsif( $value =~ /\D+/ ){ #anything else than a digit + $msg = "Error: wrong $cmd value \'$value\' for device $name, must be "; + }elsif( $value == 0 && $cmd =~ /(dimup)|(dimdown)/ ){ + $msg = "$name Error: wrong $cmd value \'$value\' given, must be 1 ... 100 "; + }elsif( $value<0 || $value>100 ){ + $msg = "$name Error: wrong $cmd value \'$value\' given, must be 0 ... 100 "; + } + if( $msg ){ + Shelly_error_handling($hash,"Shelly_Set",$msg,1); + return $msg; + } + + Log3 $name,4,"[Shelly_Set] setting brightness for device $name to $value"; + if( $shelly_models{$model}[4]==2 ){ + #Gen2 + # translate Gen1-commands to Gen2 + if( $value == 0 ){ # dim-command + $cmd="&on=false" ; + }elsif($cmd eq "pct" ){ + $cmd="&brightness=$value"; + }elsif($cmd =~ /dim(up|down)/ ){ + $cmd="&dim=$1"."\&step=$value"; + }else{ + $cmd="&brightness=$value\&on=true"; + } + Shelly_HttpRequest($hash,"/rpc/Light.Set", "?id=$channel$cmd","Shelly_response","onoff"); + }else{ + #Gen1 + my $comp; + if( $model =~ /shellyrgbw/ && $mode eq "white" ){ + $comp = "white"; + }else{ + $comp = "light"; + } + if( $value == 0 ){ # dim-command + $cmd="?turn=off" ; + }elsif($cmd eq "pct" ){ + $cmd="?brightness=$value"; + }elsif($cmd =~ /dim(up|down)/ ){ + $cmd="?dim=$1"."\&step=$value"; + }else{ + $cmd="?brightness=$value\&turn=on"; + } + Shelly_HttpRequest($hash,"/$comp","/$channel$cmd$oldtimer","Shelly_response","dim"); + } + return; + + ################################################################################################################ #-- we have a roller type device / roller mode - if( $cmd =~ /^(stop|closed|open|pct|pos|delta|zero)/ && $shelly_models{$model}[1]>0 && $mode ne "relay" ){ - $ff = 1; + }elsif( $ff==1 && $cmd =~ /^(stop|closed|open|pct|pos|delta|zero)/ ){ Log3 $name,4,"[Shelly_Set] $name: we have a $model ($mode mode) and command is $cmd"; - #x my $channel = $value; - + my $max=AttrVal($name,"maxtime",30); my $maxopen =AttrVal($name,"maxtime_open",30); my $maxclose=AttrVal($name,"maxtime_close",30); - + #-- open 100% or 0% ? my $pctnormal = (AttrVal($name,"pct100","open") eq "open"); - - #-- stop, and stay stopped - if( $cmd eq "stop" || + + #-- stop, and stay stopped + if( $cmd eq "stop" || $hash->{MOVING} eq "drive-down" && $cmd eq "closed" || $hash->{MOVING} eq "drive-up" && $cmd eq "open" || $hash->{MOVING} =~ /drive/ && $cmd eq "pct" || @@ -2118,7 +2495,7 @@ sub Shelly_Set ($@) { # -- estimate pos here ??? $hash->{DURATION} = 0; $cmd = "?go=stop"; - + #-- in some cases we stop movement and start again in reverse direction }elsif( $hash->{MOVING} eq "drive-down" && $cmd eq "open" || @@ -2129,21 +2506,31 @@ sub Shelly_Set ($@) { $hash->{DURATION} = 0; $hash->{CMD}=$cmd; RemoveInternalTimer($hash,"Shelly_Set"); - InternalTimer(time()+1.0, "Shelly_Set", $hash, 1); + InternalTimer(time()+1.0, "Shelly_Set", $hash); $cmd = "?go=stop"; - + #-- is moving !!! - }elsif( $hash->{MOVING} ne "stopped" ){ - Log3 $name,1,"[Shelly_Set] Error: received command \'$cmd\', but $name is still moving"; - - #-- is not moving - }elsif( $hash->{MOVING} eq "stopped" && $cmd eq "zero" ){ + }elsif( $hash->{MOVING} ne "stopped" ){ + Log3 $name,1,"[Shelly_Set] Error: received command \'$cmd\', but $name is still moving"; + + #-- is not moving + }elsif( $hash->{MOVING} eq "stopped" && $cmd eq "zero" ){ # we have this twice !!?? # calibration of roller device - return "comand zero deactivated"; - return Shelly_configure($hash,"rc"); - - #--any other cases: no movement and commands: open, closed, pct, pos, delta + Log3 $name,5,"[Shelly_Set] call for calibrating $name"; + if( $shelly_models{$model}[4]==0 ){ + # Gen1 + Shelly_HttpRequest($hash,"/roller","/0/calibrate","Shelly_response","config"); + #in older fw: + #Shelly_HttpRequest($hash,"/settings","?calibrate=1","Shelly_response","config"); + }else{ + # Gen2 + $cmd="rpc/Cover.Calibrate?id=0" ; + Shelly_HttpRequest($hash,"/rpc/Cover.Calibrate","?id=0","Shelly_response","config"); + } + + #--any other cases: no movement and commands: open, closed, pct, pos, delta }elsif( $cmd =~ /(closed)|(open)/ ){ + $hash->{helper}{UserDuration} = $value if( defined($value) ); if( $cmd eq "closed" ){ $hash->{DURATION} = (defined($value))?$value:$maxclose; $hash->{MOVING} = "drive-down"; @@ -2155,22 +2542,24 @@ sub Shelly_Set ($@) { $hash->{TARGETPCT} = $pctnormal ? 100 : 0; $cmd ="?go=open"; } - $cmd .= "&duration=$value" if(defined($value)); - + $cmd .= "&duration=".$hash->{DURATION} if( $shelly_models{$model}[4]<2 ); # Gen1 only + $hash->{NextUpdate}= time()+$hash->{DURATION}+1.05; # state is turned to 'stopped' with a little delay + }elsif( $cmd eq "pct" || $cmd =~ /pos/ || $cmd eq "delta" ){ my $targetpct = $value; my $pos = ReadingsVal($name,"position",""); - my $pct = ReadingsVal($name,"pct",undef); + my $pct = ReadingsVal($name,"pct",undef); if( $cmd eq "pct" && "$value" =~ /[\+-]\d*/ ){ - $targetpct = eval($pct."$value"); + $targetpct = eval($pct."$value"); } #-- check for sign if( $cmd eq "delta" ){ if( $value =~ /[\+-]\d*/ ){ $targetpct += $pct; }else{ - Log3 $name,1,"[Shelly_Set] $name: Wrong format of comand \'$cmd\', must consist of a plus or minus sign followed by an integer value"; - return; + my $err = "Wrong format of comand \'$cmd\', must consist of a plus or minus sign followed by an integer value"; + Shelly_error_handling($hash,"Shelly_Set",$err,1); + return $err; } } if( $targetpct<0 ){ @@ -2185,10 +2574,10 @@ sub Shelly_Set ($@) { } if( !$maxopen || !$maxclose ){ - Log3 $name,1,"[Shelly_Set] please set the maxtime_open/closed attributes for proper operation of device $name"; + Log3 $name,1,"[Shelly_Set] please set the maxtime_open/close attributes for proper operation of device $name"; $maxopen = $maxclose = ( $max ? $max : 20 ); } - + if( ($pctnormal && $targetpct > $pct) || (!$pctnormal && $targetpct < $pct) ){ $hash->{MOVING} = "drive-up"; $max = $maxopen; @@ -2196,38 +2585,72 @@ sub Shelly_Set ($@) { $hash->{MOVING} = "drive-down"; $max = $maxclose; } - + #$time = int(abs($targetpct-$pct)/100*$max); #$hash->{MOVING} = $pctnormal ? (($targetpct > $pct) ? "drive-up" : "drive-down") : (($targetpct > $pct) ? "drive-down" : "drive-up"); $hash->{TARGETPCT} = $targetpct; $hash->{DURATION} = abs($targetpct-$pct)/100*$max; + $hash->{NextUpdate}= time()+$hash->{DURATION}; $cmd = "?go=to_pos&roller_pos=" . ($pctnormal ? $targetpct : 100 - $targetpct); - } - Log3 $name,4,"[Shelly_Set] $name: calling Shelly_updown with comand $cmd, duration=".$hash->{DURATION}; - - # Shelly_updown performs one status update after start, and one at expected time of stop - return Shelly_updown($hash,$cmd); + } + $cmd = "/roller/0".$cmd; + Log3 $name,4,"[Shelly_Set] $name: requesting up/down with comand $cmd, duration=".$hash->{DURATION}; + + my $CMD2; + if( $shelly_models{$model}[4]==2 ){ + # Gen2 + $cmd =~ s/\?go=stop/Cover.Stop/; + $cmd =~ s/\?go=open/Cover.Open/; + $cmd =~ s/\?go=close/Cover.Close/; + $cmd =~ s/\?go=to_pos&roller_pos=/Cover.GoToPosition?pos=/; + $cmd =~ s/\/roller\/(\d)//; + my $channel = $1; # $channel=0; + # Gen2 commands: rpc/Cover.Open?id=0 [ &duration= ] + # Close?id=0 [ &duration= ] + # Stop?id=0 + # GoToPosition?id=0&pos= + # in case of success we receive "null", + # in case of error we receive $jhash->{code} and $jhash->{message} containing an err-message + if( $cmd =~ /GoTo/ ){ + my $targetpct = $hash->{TARGETPCT}; + $targetpct = ($pctnormal ? $targetpct : 100 - $targetpct); + $cmd="/rpc/Cover.GoToPosition"; + $CMD2="?pos=$targetpct&id=$channel"; + }else{ + $cmd="/rpc/$cmd"; + $CMD2="?id=$channel"; + $CMD2 .= "&duration=".$hash->{helper}{UserDuration} if( $hash->{helper}{UserDuration} ); # Gen2 only + delete $hash->{helper}{UserDuration}; + } + }else{ + # Gen1; channel is set to 0 - we don't have Gen1 multichannel roller devices + $CMD2="/0$cmd"; + $cmd="/roller"; + } + Shelly_HttpRequest($hash,$cmd,$CMD2,"Shelly_response","updown"); + return; ################################################################################################################ #-- we have a ShellyBulbDuo (it's a bulb in white mode) $ff=2 }elsif( $cmd eq "ct" ){ - $channel = shift @a; - return Shelly_dim($hash,"light/0","?temp=".$value); - - ################################################################################################################ - #-- we have a Shelly rgbw type device in color mode - #-- commands: hsv, rgb, rgbw, white, gain - }elsif( ($model =~ /shelly(rgbw|bulb).*/) && ($mode eq "color")){ - $ff = 7; - my $channel = $value; - + $channel = shift @a; + Shelly_HttpRequest($hash,"/light","/0?temp=$value$oldtimer","Shelly_response","dim"); + return; + + ################################################################################################################ + #-- we have a Shelly rgbw type device in color mode; $ff==7 + #-- commands: hsv, rgb, rgbw, white, gain, effect + }elsif( $ff==7 && $cmd =~ /hsv|rgb|white|gain|effect/ ){ + #$ff = 7; + #my $channel = $value; + Log3 $name,5,"[Shelly_Set] processing command $cmd for $name"; if( $cmd eq "hsv" ){ my($hue,$saturation,$value)=split(',',$value); - #-- rescale + #-- rescale if( $hue>1 ){ $hue = $hue/360; - } + } my ($red,$green,$blue)=Color::hsv2rgb($hue,$saturation,$value); $cmd=sprintf("red=%d&green=%d&blue=%d",int($red*255+0.5),int($green*255+0.5),int($blue*255+0.5)); if($model eq "shellybulb"){ @@ -2235,8 +2658,7 @@ sub Shelly_Set ($@) { }else{ $cmd .= sprintf("&gain=%d",$value*100); #new } - return Shelly_dim($hash,"color/0","?".$cmd); - + }elsif( $cmd =~ /rgb/ ){ my $red = hex(substr($value,0,2)); # convert hexadecimal number into decimal my $green= hex(substr($value,2,2)); @@ -2247,19 +2669,24 @@ sub Shelly_Set ($@) { } $cmd .= sprintf("&red=%d&green=%d&blue=%d",$red,$green,$blue); $cmd .= "&gain=100"; - return Shelly_dim($hash,"color/0","?".$cmd); - }elsif( $cmd eq "white" ){ # value 0 ... 100 $cmd=sprintf("white=%d",$value*2.55); - return Shelly_dim($hash,"color/0","?".$cmd); }elsif( $cmd eq "gain" ){ # value 0 ... 100 $cmd=sprintf("gain=%d",$value); - return Shelly_dim($hash,"color/0","?".$cmd); + }elsif( $cmd eq "effect" ){ # value 0 ... 3 + $value = 0 if( $value eq 'Off' ); + $cmd=sprintf("effect=%d",$value); + }else{ + my $err = "no handler for command \'$cmd\'"; + Shelly_error_handling($hash,"Shelly_Set:rgbw",$err,1); + return $err; } + Shelly_HttpRequest($hash,"/color","/0?$cmd$oldtimer","Shelly_response","dim"); + return; } - + ########################################################################### - #-- commands independent of Shelly type: password, interval, reboot, update + #-- commands independent of Shelly type: password, interval, reboot, update, .... if( $cmd eq "password" ){ my $user = AttrVal($name,"shellyuser",undef); if(!$user && $shelly_models{$model}[4]==0 ){ @@ -2268,165 +2695,248 @@ sub Shelly_Set ($@) { return $msg; } setKeyValue("SHELLY_PASSWORD_$name", $value); + Shelly_status($hash); + InternalTimer(time()+0.9, "Refresh", $hash) if( $init_done ); # perform a browser refresh return undef; - + }elsif( $cmd eq "interval" ){ - if( IsInt($value) && $value >= 0){ # see 99_Utils.pm + $value = int($value); + if( IsInt($value) && $value > 0){ # see 99_Utils.pm $hash->{INTERVAL}=int($value); + Shelly_Set($hash,$name,"startTimer"); + }elsif( $value == 0 ){ + $hash->{INTERVAL}=0; + readingsSingleUpdate( $hash,"state","disabled",1 ); + Log3 $name,2,"[Shelly_Set:interval] No timer started for $name, device is disabled"; }elsif( $value == -1 ){ - $hash->{INTERVAL}=AttrVal($name,"interval",$defaultINTERVAL); + $value =AttrVal($name,"interval",$defaultINTERVAL); + $hash->{INTERVAL}=$value; + Log3 $name,2,"[Shelly_Set:interval] interval for $name set to $value"; + Shelly_Set($hash,$name,"startTimer"); }else{ - my $msg = "Value is not an positve integer"; - Log3 $name,1,"[Shelly_Set] ".$msg; + my $msg = "Value \'$value\' is not valid"; + Log3 $name,1,"[Shelly_Set:interval] $name: ".$msg; return $msg; } - Log3 $name,1,"[Shelly_Set] Setting interval of $name to ".$hash->{INTERVAL}; - #### Shelly_Set($hash->{NAME},"startTimer"); - if( $hash->{INTERVAL} ){ - Log3 $name,2,"[Shelly_Set] Starting cyclic timers for $name ($model)"; - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+$hash->{INTERVAL}, "Shelly_status", $hash, 0); - RemoveInternalTimer($hash,"Shelly_shelly"); - InternalTimer(time()+$defaultINTERVAL*$secndIntervalMulti, "Shelly_shelly", $hash,0); - if( $model eq "shellypro3em" ){ - RemoveInternalTimer($hash,"Shelly_EMData"); - InternalTimer(int((time()+60)/60)*60+1, "Shelly_EMData", $hash,0); - Log3 $name,2,"[Shelly_Set] Starting cyclic EM-Data timers for $name"; - } - }else{ - Log3 $name,2,"[Shelly_Set] No timer started for $name"; - } - return undef; - - }elsif( $cmd eq "startTimer" ){ - if( $hash->{INTERVAL} ){ - Log3 $name,2,"[Shelly_Set] Starting cyclic timers for $name"; - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+$hash->{INTERVAL}, "Shelly_status", $hash, 0); - RemoveInternalTimer($hash,"Shelly_shelly"); - InternalTimer(time()+$defaultINTERVAL*$secndIntervalMulti, "Shelly_shelly", $hash,0); - RemoveInternalTimer($hash,"Shelly_EMData"); - InternalTimer(int((time()+60)/60)*60+1, "Shelly_EMData", $hash,0); - }else{ - Log3 $name,2,"[Shelly_Set] No timer started for $name"; - } - return "started";#undef; - - }elsif( $cmd eq "reboot" ){ - Log3 $name,1,"[Shelly_Set] Rebooting $name"; - Shelly_configure($hash,$cmd); return undef; - }elsif( $cmd eq "update") { - Log3 $name,1,"[Shelly_Set] Updating $name"; - # if( $shelly_models{$model}[4]==0 ){$cmd ="ota/update";} # Gen1 only - Shelly_configure($hash,$cmd); + }elsif( $cmd eq "startTimer" ){ # starting/stopping timer + my $timer=$hash->{INTERVAL}; + my $msg; + RemoveInternalTimer($hash,"Shelly_status"); + RemoveInternalTimer($hash,"Shelly_getEMvalues"); + RemoveInternalTimer($hash,"Shelly_getEMData"); + if( $timer ){ + $msg = "(Re-)Starting cyclic timers: "; + InternalTimer(time()+$timer, "Shelly_status", $hash); + $msg .= "status-timer=$timer"; + if( $model eq "shellypro3em" ){ + # + RemoveInternalTimer($hash,"Shelly_getEMvalues"); + $timer=1; #$hash->{INTERVAL}/4; + InternalTimer(time()+$hash->{INTERVAL}/4, "Shelly_getEMvalues", $hash); + $msg .= ", EM power-values-timer=$timer"; + # + RemoveInternalTimer($hash,"Shelly_getEMData"); + $timer=int((time()+60)/60)*60+1 - time(); # +60 + InternalTimer(int((time()+60)/60)*60+1, "Shelly_getEMData", $hash); + $msg .= ", EM energy-data-timer=$timer"; + } + }else{ + $msg = "Device $name is disabled, timer canceled"; + } + Log3 $name,4,"[Shelly_Set:startTimer] $name: $msg"; return undef; - + + }elsif( $cmd eq "calibrate" ){ # shelly-dimmer + Log3 $name,1,"[Shelly_Set] call for Calibrating $name"; + if( $shelly_models{$model}[4]==0 ){ + #$cmd="settings?calibrate=1"; + Shelly_HttpRequest($hash,"/settings","?calibrate=1","Shelly_response","config"); + }else{ + # Gen2; returns 'null' on success + Shelly_HttpRequest($hash,"/rpc/Light.Calibrate","?id=0","Shelly_response","config"); + } + + }elsif(0&& $cmd eq "zero" ){ # shelly-roller, cover + Log3 $name,1,"[Shelly_Set] call for Calibrating $name"; + if( $shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest($hash,"/settings","?calibrate=1","Shelly_response","config"); + }else{ + Shelly_HttpRequest($hash,"/rpc/Cover.Calibrate","?id=0","Shelly_response","config"); + } + + }elsif( $cmd eq "reboot" ){ + Log3 $name,1,"[Shelly_Set] call for Rebooting $name"; + if( $shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest($hash,"/reboot","","Shelly_response","config"); + }else{ + Shelly_HttpRequest($hash,"/rpc/Shelly.Reboot","","Shelly_response","config"); + } + return undef; + + }elsif( $cmd eq "update" ){ + Log3 $name,1,"[Shelly_Set] call for Updating $name"; + if( $shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest($hash,"/ota","?update=true","Shelly_response","config"); + }else{ + $cmd="rpc/Shelly.Update?stage=%22stable%22" ; #beta + Shelly_HttpRequest($hash,"/rpc/Shelly.Update","?stage=%22stable%22","Shelly_response","config"); + } + return undef; + }elsif( $cmd eq "reset" ){ + ## CLR + return "deprecated, use \'clear\' instead"; + }elsif( $cmd eq "clear" ){ my $doreset = $value; + my $comp; Log3 $name,4,"[Shelly_Set] Resetting counter \'$doreset\' of device $name"; if( $doreset eq "disconnects" ){ readingsSingleUpdate($hash,"network_disconnects",0,1); + }elsif( $doreset eq "error" ){ + readingsSingleUpdate($hash,"error","-",1); + }elsif( $doreset eq "responsetimes" ){ + my $ptrclrcnt = 0; + foreach my $ptr ('/rpc/Shelly.GetStatus','/rpc/Shelly.GetConfig','/rpc/Shelly.GetDeviceInfo','/rpc/EM.GetStatus','/rpc/EMData.GetStatus', + '/rpc/BLE.CloudRelay.List','/rpc/Webhook.List','/rpc/Webhook.Update','/rpc/Wifi.ListAPClients', + '/rpc/PM1.ResetCounters', + '/shelly','/status','/settings','/settings/actions','/_nextUpdateTimer' ){ + if( ReadingsVal($name,$ptr,undef) ){ + readingsSingleUpdate($hash,$ptr,"-",1); #clear process time reading + $ptrclrcnt++; + } + } + Log3 $name,2,"[Shelly_Set:Clear] Clearing $ptrclrcnt process time readings at device $name"; }elsif( $doreset eq "energy" ){ if( ReadingsVal($name,"firmware","") =~ /(v0|v1.0)/ ){ my $err = "firmware must be at least v1.1.0"; - Shelly_error_handling($hash,"Shelly_Set:reset",$err); + Shelly_error_handling($hash,"Shelly_Set:clear",$err,1); return $err; } my $numC; if( $shelly_models{$model}[0]>0 && $mode ne "roller" ){ - $cmd = "Switch"; + $comp = "Switch"; $numC = $shelly_models{$model}[0]; }elsif( $shelly_models{$model}[1]>0 && $mode ne "relay" ){ - $cmd = "Cover"; + $comp = "Cover"; $numC = $shelly_models{$model}[1]; + }elsif( $numC=$shelly_models{$model}[2]>0 && $mode ne "color" ){ + $comp = "lights"; + # $numC = $shelly_models{$model}[2]; + }elsif( $numC=$shelly_models{$model}[7]>0 && $mode ne "white" ){ + $comp = "lights"; + # $numC = $shelly_models{$model}[7]; }elsif( $shelly_models{$model}[3]>0 && !$mode ){ - $cmd = "PM1"; + return if( ReadingsVal($name,'model_id','') !~ /^S.PM/ ); + $comp = "PM1"; $numC = $shelly_models{$model}[3]; - }else{ - Log3 $name,1,"[Shelly_configure] Wrong command $cmd"; + }else{ + Log3 $name,1,"[Shelly_Set] Wrong component $comp"; return; } for( my $id=0; $id<$numC; $id++ ){ - Shelly_configure($hash,"rpc/$cmd\.ResetCounters?id=$id&type=[\"aenergy\"]"); - #readingsSingleUpdate($hash,"energy_$id","-",1) if( ReadingsNum($name,"energy_$id",undef) ); - Shelly_status($hash); + Shelly_HttpRequest($hash,"/rpc/$comp\.ResetCounters","?id=$id&type=[\"aenergy\"]","Shelly_response","config_$id"); } } return undef; #-- renaming the Shelly, spaces in name are allowed }elsif( $cmd eq "name") { #ShellyName - my $newname; + my ($newname,$urlcmd); if( defined $value ){ $newname=$value; while( $value=shift @a ){ $newname .= " ". $value; - } + } }else{ my $msg = "Error: wrong number of parameters"; Log3 $name,1,"[Shelly_Set] ".$msg; return $msg; } readingsSingleUpdate($hash,"name",$newname,1); - $msg = "The Shelly linked to $name is named to \'$newname\'"; + $msg = "The Shelly linked to $name is named to \'$newname\'"; Log3 $name,1,"[Shelly_Set] $msg"; - $newname =~ s/ /%20/g; #spaces not allowed in urls + $newname =~ s/ /%20/g; #spaces not allowed in urls if( $shelly_models{$model}[4]>=1 ){ - $cmd="rpc/Sys.SetConfig?config={%22device%22:{%22name%22:%22$newname%22}}" ; + $cmd="/rpc/Sys.SetConfig" ; + $urlcmd="?config={%22device%22:{%22name%22:%22$newname%22}}"; # {"device" :{" name" : "arg"}} - }else{ - $cmd="settings?name=$newname"; + }else{ + $cmd="/settings"; + $urlcmd="?name=$newname"; } - Shelly_configure($hash,$cmd); + Shelly_HttpRequest($hash,$cmd,$urlcmd,"Shelly_response","config"); return $msg; - - #-- command config largely independent of Shelly type - }elsif($cmd eq "config") { - my $reg = $value; - my ($val,$chan); - if( int(@a) == 2 ){ - $chan = $a[1]; - $val = $a[0]; - }elsif( int(@a) == 1 ){ - $chan = 0; - $val = $a[0]; - }else{ - my $msg = "Error: wrong number of parameters"; - Log3 $name,1,"[Shelly_Set] ".$msg; - return $msg; - } - my $pre = "settings/"; - if( ($model =~ /shelly2.*/) && ($mode eq "roller") ){ ##R - $pre .= "roller/0?"; - }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "white") ){ - $pre .= "white/0?"; - }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "color") ){ - $pre .= "color/0?"; - }elsif( $model eq "shellydimmer" ){ - $pre .= "light/0?"; - }else{ - $pre .= "relay/$chan?"; - } - Shelly_configure($hash,$pre.$reg."=".$val); - return undef; - + + #-- command config largely independent of Shelly type + }elsif($cmd eq "config"){ + if( $shelly_models{$model}[4] == 0 ){ + # Gen1 + my $reg = $value; #the register, eg auto_off + my ($val,$chan); + if( int(@a) == 2 ){ + $chan = $a[1]; + $val = $a[0]; + }elsif( int(@a) == 1 ){ + $chan = 0; + $val = $a[0]; + }else{ + my $msg = "Error: wrong number of parameters"; + Log3 $name,1,"[Shelly_Set] ".$msg; + return $msg; + } + my $pre = "/settings/"; + if( ($model =~ /shelly2.*/) && ($mode eq "roller") ){ ##R + $pre .= "roller/0"; + }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "white") ){ + $pre .= "white/0"; + }elsif( ($model eq "shellyrgbw" || $model eq "shellybulb") && ($mode eq "color") ){ + $pre .= "color/0"; + }elsif( $model eq "shellydimmer" ){ + $pre .= "light/0"; + }else{ + $pre .= "relay/$chan"; + } + Shelly_HttpRequest($hash,$pre,"?$reg=$val","Shelly_response","config"); + }else{ + #Gen2 + my $config_cmd = $value; + my $tf = "enable"; + $tf = "disable" if( $config_cmd eq "ap_disable" ); + $tf =~ s/enable/true/; + $tf =~ s/disable/false/; + Shelly_HttpRequest($hash,"/rpc/Wifi.SetConfig","?config={'ap':{'enable':$tf}}","Shelly_response","config"); + # on success returns 'restart required NO' + } + return undef; + + }elsif( $cmd eq "input"){ ## ToDo works only for devices with one input! + return "wrong command" if( $value !~ /action|detached|edge|momentary|switch|toggle/ ); + if( ReadingsVal($name,"input_mode","unknown") !~ /$value/ ){ + Log3 $name,1,"[Shelly_Set:input] changing input type of $name: btn_type=$value";#1 + Shelly_HttpRequest($hash,"/settings/relay/0","?btn_type=$value","Shelly_response","config"); + # answer may be: Bad button type! + }else{ + Log3 $name,4,"[Shelly_Set:input] input type of $name is already of btn_type=$value";#4 + } + return undef; + #-- fill in predefined attributes for roller devices }elsif( $cmd eq "predefAttr") { return "keine Kopiervorlage verfügbar" if( $mode ne "roller" ); - + return "Set the attribute\'pct100\' first" if( !AttrVal($name,"pct100",undef) ); $msg = "$name:\n"; my $devStateIcon; my $changes = 0; - if( !AttrVal($name,"devStateIcon",undef) ){ + if( !AttrVal($name,"devStateIcon",undef) ){ if( AttrVal($name,"pct100","open") eq "open" ){ $devStateIcon = $predefAttrs{'roller_open100'}; }else{ $devStateIcon = $predefAttrs{'roller_closed100'}; } - # set the devStateIcon-attribute when the devStateIcon attribute is not set yet + # set the devStateIcon-attribute when the devStateIcon attribute is not set yet $attr{$hash->{NAME}}{devStateIcon} = $devStateIcon; Log3 $name,5,"[Shelly_Get] the attribute \'devStateIcon\' of device $name is set to \'$devStateIcon\' "; $msg .= "devStateIcon attribute is set"; @@ -2435,8 +2945,8 @@ sub Shelly_Set ($@) { $msg .= "attribute \'devStateIcon\' is already defined"; } $msg .= "\n"; - if( !AttrVal($name,"webCmd",undef) ){ - # set the webCmd-attribute when the webCmd attribute is not set yet + if( !AttrVal($name,"webCmd",undef) ){ + # set the webCmd-attribute when the webCmd attribute is not set yet $attr{$hash->{NAME}}{webCmd} = $predefAttrs{'roller_webCmd'}; Log3 $name,5,"[Shelly_Get] the attribute \'webCmd\' of device $name is set "; $msg .= "webCmd attribute is set"; @@ -2445,8 +2955,8 @@ sub Shelly_Set ($@) { $msg .= "attribute \'webCmd\' is already defined"; } $msg .= "\n"; - if( !AttrVal($name,"cmdIcon",undef) ){ - # set the cmdIcon-attribute when the cmdIcon attribute is not set yet + if( !AttrVal($name,"cmdIcon",undef) ){ + # set the cmdIcon-attribute when the cmdIcon attribute is not set yet $attr{$hash->{NAME}}{cmdIcon} = $predefAttrs{'roller_cmdIcon'}; Log3 $name,5,"[Shelly_Get] the attribute \'cmdIcon\' of device $name is set "; $msg .= "cmdIcon attribute is set"; @@ -2455,8 +2965,8 @@ sub Shelly_Set ($@) { $msg .= "attribute \'cmdIcon\' is already defined"; } $msg .= "\n"; - if( !AttrVal($name,"eventMap",undef) ){ - # set the eventMap-attribute when the eventMap attribute is not set yet + if( !AttrVal($name,"eventMap",undef) ){ + # set the eventMap-attribute when the eventMap attribute is not set yet if( AttrVal($name,"pct100","open") eq "open" ){ $attr{$hash->{NAME}}{eventMap} = $predefAttrs{'roller_eventMap_open100'}; }else{ @@ -2470,10 +2980,10 @@ sub Shelly_Set ($@) { } $msg .= "\n\n to see the changes, browser refresh is necessary" if( $changes ); return $msg; - + #-- create readingsProxy devices }elsif( $cmd eq "xtrachannels" ){ - Log3 $name,3,"[Shelly_Set] readingsProxy devices for $name requested"; + Log3 $name,3,"[Shelly_Set] readingsProxy devices for $name requested"; if( $shelly_models{$model}[$ff]>1){ my $channelType = ($ff==0)?'relay':'light'; my $i; @@ -2487,7 +2997,7 @@ sub Shelly_Set ($@) { if( $shelly_models{$model}[$ff] == $shelly_models{$model}[5] ){ fhem("attr $name\_$i userReadings input {ReadingsVal(\"$name \",\"input_$i\",\"\")}"); } - Log3 $name,1,"[Shelly_Set] readingsProxy device ".$name."_$i created"; + Log3 $name,1,"[Shelly_Set] readingsProxy device ".$name."_$i created"; } $msg = "$i devices for $name created"; }else{ @@ -2495,22 +3005,24 @@ sub Shelly_Set ($@) { Log3 $name,1,"[Shelly_Set] ".$msg; } return $msg; + }elsif( $cmd =~ /blink|intervals|off-till|on-till/ ){ + Log3 $name,3,"[Shelly_Set] calling SetExtension \'$cmd\' for $name"; + SetExtensions($hash,$hash->{helper}{Sets},$name,$cmd,@args); }else{ - - - $parameters=( scalar(@args)?" and ".scalar(@args)." parameters: ".join(" ",@args) : ", no parameters" ); - Log3 $name,1,"[Shelly_Set] parsed, outstanding call for device $name with command \'$cmd\'$parameters" if($cmd ne "?");#4 -return SetExtensions($hash,$hash->{helper}{Sets},$name,$cmd,@args); - return "$model $mode: unknown argument $cmd choose one of ".$hash->{helper}{Sets}; - } + $parameters=( scalar(@args)?" and ".scalar(@args)." parameters: ".join(" ",@args) : ", no parameters" ); + $msg="commands parsed, outstanding call for device $name with command \'$cmd\'$parameters"; # if($cmd ne "?") + Shelly_error_handling($hash,"Shelly_Set",$msg,1); + return $msg; + } return undef; -} +} # End Shelly_Set() + ######################################################################################## # # Shelly_pwd - retrieve the credentials if set # -# Parameter hash +# Parameter hash # ######################################################################################## @@ -2526,501 +3038,178 @@ sub Shelly_pwd($){ return "$user:$pw\@"; } -######################################################################################## -# -# Shelly_configure - Configure Shelly device or read general configuration -# acts as callable program Shelly_configure($hash,$cmd) -# and as callback program Shelly_configure($hash,$cmd,$err,$data) -# -# Parameter hash, cmd = command -# -######################################################################################## - - sub Shelly_configure { - my ($hash, $cmd, $err, $data) = @_; - my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; - my $net = $hash->{READINGS}{network}{VAL}; - return "no network information" if( !defined $net ); - return "device not connected" - if( $net =~ /not connected/ ); - - my $model = AttrVal($name,"model","generic"); - my $creds = Shelly_pwd($hash); - - ##2ndGen devices will answer with "null\R" - if( $cmd eq "update" ){ - if( $shelly_models{$model}[4]>=1 ){ - $cmd="rpc/Shelly.Update?stage=%22stable%22" ; #beta - }else{ - $cmd="ota?update=true"; - } - }elsif( $cmd eq "reboot" ){ - if( $shelly_models{$model}[4]>=1 ){ - $cmd="rpc/Shelly.Reboot" ; - }else{ - $cmd="reboot"; - } - }elsif( $cmd =~ /ResetCounters/ ){ - Log3 $name,5,"[Shelly_configure] resetting energy-counter for device $name ($cmd)"; - - }elsif( $cmd eq "rc" || $cmd eq "calibrate" ){ - if( $shelly_models{$model}[4]>=1 ){ - $cmd="rpc/Cover.Calibrate?id=0" ; #Gen2 - }elsif( $shelly_models{$model}[1]==1 && AttrVal($name,"mode",undef) eq "roller" ){ - $cmd="roller/0/calibrate"; - }else{ - $cmd="settings?calibrate=1"; # shelly-dimmer - } - } - - Log3 $name,5,"[Shelly_configure] $name: received command=$cmd"; - - if( $hash && !$err && !$data ){ - my $url = "http://$creds".$hash->{TCPIP}."/".$cmd; - Log3 $name,4,"[Shelly_configure] issue a non-blocking call to $url"; - HttpUtils_NonblockingGet({ - url => $url, - timeout => AttrVal($name,"timeout",4), - callback => sub($$$){ Shelly_configure($hash,$cmd,$_[1],$_[2]) } - }); - return undef; - }elsif( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_configure",$err); - return; - } - Log3 $name,3,"[Shelly_configure] device $name has returned ".length($data)." bytes of data"; - Log3 $name,5,"[Shelly_configure] device $name has returned data:\n\"$data\""; - - if( $shelly_models{$model}[4]>=1 ){ - if( $data =~ /null/ ){ #\R ? perl 5.10.0, in older versions: \r or \n - readingsSingleUpdate($hash,"config","successful",1); - }elsif( $data =~ /energy/ ){ - readingsSingleUpdate($hash,"config","counter set to 0",1); - }else{ - Log3 $name,1,"[Shelly_configure] $name: Error while processing \'$cmd\'"; - Shelly_error_handling($hash,"Shelly_configure","Error"); - } - return; - } - - # proceed only on Gen 1 devices - - # extracting json from data - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - Shelly_error_handling($hash,"Shelly_configure","invalid JSON data"); - return; - } - - #-- if settings command, we obtain only basic settings - if( $cmd eq "settings/" ){ - $hash->{SHELLYID} = $jhash->{'device'}{'hostname'}; - return - }elsif( $cmd =~ /ota/ ){ # ota?update=true - readingsSingleUpdate($hash,"config","updating",1); - return undef; - }elsif( $cmd =~ /reboot/ ){ # Answer is: {"ok":true} - readingsSingleUpdate($hash,"config","rebooting",1); - return undef; - } - # $cmd example: settings/relay/0?auto_off=35 - Log3 $name,4,"[Shelly_configure] device $name processing \"$cmd\" ";#4 - #-- isolate register name - my $reg = substr($cmd,index($cmd,"?")+1); - my $chan= substr($cmd,index($cmd,"?")-1,1); - $reg = substr($reg,0,index($reg,"=")) - if(index($reg,"=") > 0); - my $val = $jhash->{$reg}; - - $chan = $shelly_models{$model}[7] == 1 ? "" : "[channel $chan]"; - - if( defined($val) ){ - Log3 $name,4,"[Shelly_configure] device $name result is reg: $reg $chan value $val "; - readingsSingleUpdate($hash,"config","$reg=$val $chan",1); - }else{ - Log3 $name,4,"[Shelly_configure] device $name no result found for register $reg $chan"; - readingsSingleUpdate($hash,"config","register \'$reg\' not found or empty $chan",1); - } - - return undef; -} - ######################################################################################## # -# Shelly_status - Retrieve data from device -# acts as callable program Shelly_status($hash) -# and as callback program Shelly_status($hash,$err,$data) (only for 1G) -# -# Parameter hash +# Shelly_status - Endpoint for Internal Timers +# Shelly_getEMvalues - Endpoint for Internal Timers (ShellyPro3EM only) +# Shelly_getEMData - Endpoint for Internal Timers (ShellyPro3EM only) # ######################################################################################## - -sub Shelly_inputstatus { - my ($hash) = @_; - Shelly_status($hash,"input"); -} - -sub Shelly_status { - my ($hash, $comp, $err, $data) = @_; - my $name = $hash->{NAME}; -return if( $hash->{INTERVAL} == 0 ); - my $state = $hash->{READINGS}{state}{VAL}; - - my $model = AttrVal($name,"model","generic"); - - my $creds = Shelly_pwd($hash); - my $url = "http://$creds".$hash->{TCPIP}; - my $timeout = AttrVal($name,"timeout",4); - - # for any callbacks restart timer - if( $hash && $err && $hash->{INTERVAL} != 0 ){ ## ($err || $data ) - #-- cyclic update nevertheless - RemoveInternalTimer($hash,"Shelly_status"); - my $interval=minNum($hash->{INTERVAL},$defaultINTERVAL*$secndIntervalMulti); - Log3 $name,3,"[Shelly_status] $name: Error in callback, update in $interval seconds"; - InternalTimer(time()+$interval, "Shelly_status", $hash, 1); - } - - # in any cases check for error in non blocking call - if( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_status",$err); - return $err; - } - #-- check if 2nd generation device - my $is2G = ($shelly_models{$model}[4]>=1 ? 1 : 0 );#Log3 $name,0,"$model $is2G"; -#3G { - # preparing Non Blocking Get #-------------------------------------------------- - - if( $hash && !$err && !$data ){ - #-- for 1G devices status is received in one single call - if( !$is2G ){ - $url .= "/status"; - Log3 $name,4,"[Shelly_status(1G)] issue a non-blocking call to $url"; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,undef,$_[1],$_[2]) } - }); - #-- 2G devices - }else{ - $comp = AttrVal($name,"mode","relay") if(!$comp); - $url .= "/rpc/"; - my $id=0; - my $chn=1; #number of channels - if($model eq "shellypro3em"){ - $comp = "EM"; - $url .= "EM.GetStatus"; - }elsif($model eq "shellypluspm" || $model eq "shellypmmini" ){ - $comp = "pm1"; - $url .= "PM1.GetStatus"; - #$chn = $shelly_models{$model}[5]; - }elsif($model eq "shellyplusi4"||$comp eq "input"){ - $comp = "input"; - $url .= "Input.GetStatus"; - $chn = $shelly_models{$model}[5]; - }elsif($model eq "shellyprodual" || $comp eq "roller"){ - $url .= "Cover.GetStatus"; - $chn = $shelly_models{$model}[1]; - }elsif( $comp eq "relay"){ - $url .= "Switch.GetStatus"; - $chn = $shelly_models{$model}[0]; - }else{ - $err = "unknown model \'$model\' or mode \'$comp\' "; - Shelly_error_handling( $hash,"Shelly_status",$err); - return $err; - } - $chn = 1 if( ReadingsVal($name,"state","") =~ /Error/ ); - $url .= "?id="; - #-- get status of component (relay, roller, input, EM, ...); we need to submit the call several times - for( $id=0; $id<$chn; $id++){ - #$url = $url_."?id=".$id; - Log3 $name,4,"[Shelly_status] issue a non-blocking call to $url$id, callback to proc2G for comp=$comp"; #4 - HttpUtils_NonblockingGet({ - url => $url.$id, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,$comp,$_[1],$_[2]) } - }); - } - } - return undef; - } - - # processing incoming data #-------------------------------------------------- - Log3 $name,5,"[Shelly_status] device $name of model $model has returned data \n$data"; - - # extracting json from data - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - #-- error in data - if( !$jhash ){ - Shelly_error_handling($hash,"Shelly_status","invalid JSON data"); - return; -# }elsif(ReadingsVal($name,"network","") !~ /connected to/){ - }elsif(1){ - readingsBeginUpdate($hash); - # as we have received a valid JSON, we know network is connected: we dont need this here - #readingsBulkUpdateIfChanged($hash,"network","connected to {TCPIP}."\">".$hash->{TCPIP}."",1); - #transition - if( $jhash->{'lights'}[0]{'transition'} ){ - my $chn = $shelly_models{$model}[2]; - $chn = 1 if( AttrVal($name,"mode", "color") eq "color" ); - my $subs; - my $transition; - for( my $i=0;$i<$chn;$i++){ - $transition = $jhash->{'lights'}[$i]{'transition'}; # 0 .... 5000 - $subs = ($chn>1 ? "_$i" : "" ); - Shelly_readingsBulkUpdate($hash,"transition$subs",$transition.$si_units{time_ms}[$hash->{units}]); - } - } - #-- look for transition time (bulbs only); time in milli-seconds - if(0&&$jhash->{'transition'}) { - readingsBulkUpdateMonitored($hash,"transition", $jhash->{'transition'}.$si_units{time_ms}[$hash->{units}]); - } - readingsEndUpdate($hash,1); - } - - my $next; # Time offset in seconds for next update - if( !$is2G && !$comp ){ - $next=Shelly_proc1G($hash,$jhash); - Log3 $name,4,"[Shelly_status] $name: proc1G returned with value=$next"; - }else{ - $next=Shelly_proc2G($hash,$comp,$jhash); - Log3 $name,4,"[Shelly_status] $name: proc2G returned with value=$next for comp $comp"; #4 - } - return undef if( $next == -1 ); - - #-- cyclic update (or update close to on/off-for-timer command) - - if( !defined($next) || $next > 1.5*$hash->{INTERVAL} || $next==0 ){ # remaining timer as previously read - $next = $hash->{INTERVAL}; - }elsif( $next > $hash->{INTERVAL} ){ - $next = 0.75*$hash->{INTERVAL}; - } - - Log3 $name,4,"[Shelly_status] $name: next update in $next seconds".(defined($comp)?" for Comp=$comp":""); #4 - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+$next, "Shelly_status", $hash, 1) - if( $hash->{INTERVAL} != 0 ); - return undef; -} - - - -######################################################################################## -# -# Shelly_shelly - Retrieve additional data from device (network, firmware, webhooks, etc) -# acts as callable program Shelly_shelly($hash) -# -# Parameter hash -# -######################################################################################## - -sub Shelly_shelly { +sub Shelly_status($){ my ($hash) = @_; my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; -return if( $hash->{INTERVAL} == 0 ); + my $timer = $hash->{INTERVAL}; + my $model = AttrVal($name,"model","generic"); - my $creds = Shelly_pwd($hash); - my $url = "http://$creds".$hash->{TCPIP}; - my $timeout = AttrVal($name,"timeout",4); - - Log3 $name,4,"[Shelly_shelly] $name is a ".($shelly_models{$model}[4]==0?"first":"second")." Gen device"; - #-- check if 2nd generation device - if( $shelly_models{$model}[4]==0 ){ - # handling 1st Gen devices - #Log3 $name,4,"[Shelly_shelly] intentionally aborting, $name is not 2nd Gen"; - #return undef ; - #-- get settings of 1st-Gen-Shelly - $url .= "/settings"; - Log3 $name,4,"[Shelly_shelly] issue a non-blocking call to ".$url; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,"settings",$_[1],$_[2]) } - }); - }else{ - # handling 2nd Gen devices - my $url_ = $url."/rpc/"; - - #-- get status of Shelly (updates, status, ...) - $url = $url_."Shelly.GetStatus"; - Log3 $name,4,"[Shelly_shelly] issue a non-blocking call to ".$url; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,"status",$_[1],$_[2]) } - }); - - #-- get config of Shelly - - $url = $url_."Shelly.GetConfig"; - Log3 $name,4,"[Shelly_shelly] issue a non-blocking call to ".$url; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,"config",$_[1],$_[2]) } - }); - - #-- get device info of Shelly - $url = $url_."Shelly.GetDeviceInfo"; - Log3 $name,4,"[Shelly_shelly] issue a non-blocking call to ".$url; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => $timeout, - callback => sub($$$){ Shelly_status($hash,"info",$_[1],$_[2]) } - }); - - # Shelly_webhook($hash,"Check"); # check webhooks regarding change of port, token etc. - Shelly_webhook($hash,"Count"); # check number of webhooks on Shelly + if($shelly_models{$model}[4]==0 ){ + Shelly_HttpRequest( $hash,"/status",undef,"Shelly_status1G" ); + }elsif( $shelly_models{$model}[4]>=1 ){ + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetStatus",undef,"Shelly_status2G" ); + } + #-- force cyclic update (may be overwritten by HTTP-Callback) + if( $hash->{helper}{timer} ){ + $timer = $hash->{helper}{timer}; + delete $hash->{helper}{timer}; + } + return if( $timer == 0 ); # do not update when disabled + RemoveInternalTimer($hash,"Shelly_status"); + InternalTimer(time()+$timer, "Shelly_status", $hash); + Log3 $name,4,"[Shelly_status] $name: Status-Timer restartet, update in $timer seconds"; +} #END Shelly_status() + +########################## +sub Shelly_getEMvalues($){ + my ($hash) = @_; + my $name = $hash->{NAME}; + return if( $hash->{INTERVAL} == 0 ); + my $model = AttrVal($name,"model","generic"); + + if( $model eq "shellypro3em"){ + Shelly_HttpRequest( $hash,"/rpc/EM.GetStatus","?id=0","Shelly_procEMvalues" ); } - ### cyclic update ### - RemoveInternalTimer($hash,"Shelly_shelly"); - return undef - if( $hash->{INTERVAL} == 0 ); - - my $offset = maxNum($hash->{INTERVAL},$defaultINTERVAL)*$secndIntervalMulti; #$hash->{INTERVAL}; - if( $model eq "shellypro3em" ){ - # updates at every multiple of 60 seconds - $offset = $hash->{INTERVAL}<=60 ? 60 : int($hash->{INTERVAL}/60)*60 ; - # adjust to get readings 2sec after full minute - $offset = $offset + 2 - time() % 60; - } - Log3 $name,4,"[Shelly_shelly] $name: long update in $offset seconds, Timer is Shelly_shelly"; #4 - InternalTimer(time()+$offset, "Shelly_shelly", $hash, 1); - return undef; } - -sub Shelly_actionCheck { +########################## +sub Shelly_getEMData($){ my ($hash) = @_; - my $name=$hash->{NAME}; - Log3 $name,4,"[Shelly_actionCheck] $name"; - Shelly_webhook($hash,"Check"); # check webhooks regarding change of port, token etc. -} + my $name = $hash->{NAME}; + return if( $hash->{INTERVAL} == 0 ); + my $model = AttrVal($name,"model","generic"); + + if( $model eq "shellypro3em"){ + Shelly_HttpRequest( $hash,"/rpc/EMData.GetStatus","?id=0","Shelly_procEMData" ); + } +} # END Shelly_getEMData() + ######################################################################################## -# -# Shelly_proc1G - process data from device 1st generation +# +# Shelly_status1G - process status data from device 1st generation # In 1G devices status are all in one call # ######################################################################################## -sub Shelly_proc1G { - my ($hash, $jhash) = @_; - $hash->{units}=0 if( !defined($hash->{units}) ); +sub Shelly_status1G { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; my $name = $hash->{NAME}; my $state = $hash->{READINGS}{state}{VAL}; - - my $model = AttrVal($name,"model","generic"); - + my $intervalN = $hash->{INTERVAL}; # next update interval + + my $model = AttrVal($name,"model","generic"); + my $mode = AttrVal($name,"mode",""); - my $mode = AttrVal($name,"mode",""); - my $channels = $shelly_models{$model}[0]; - my $rollers = $shelly_models{$model}[1]; - my $dimmers = $shelly_models{$model}[2]; - my $meters = $mode eq "roller" ? $shelly_models{$model}[1] : $shelly_models{$model}[3]; - my ($subs,$ison,$source,$rstate,$rstopreason,$rcurrpos,$position,$rlastdir,$pct,$pctnormal); my ($overpower,$power,$energy); - my $intervalN=$hash->{INTERVAL}; # next update interval - + readingsBeginUpdate($hash); - Shelly_readingsBulkUpdate($hash,"network","connected to {TCPIP}."\">".$hash->{TCPIP}."",1); + Shelly_readingsBulkUpdate($hash,"network","connected to {DEF}."\">".$hash->{DEF}."",1); # formerly $hash->{TCPIP} readingsBulkUpdateMonitored($hash,"network_rssi",Shelly_rssi($hash,$jhash->{'wifi_sta'}{'rssi'}) ); - readingsBulkUpdateMonitored($hash,"network_ssid",$jhash->{'wifi_sta'}{'ssid'} ) + readingsBulkUpdateMonitored($hash,"network_ip-address",$jhash->{wifi_sta}{ip} ); + readingsBulkUpdateMonitored($hash,"network_ssid",$jhash->{'wifi_sta'}{'ssid'} ) if( $jhash->{'wifi_sta'}{'ssid'} ); - - #-- for all models set internal temperature reading and status - if($jhash->{'temperature'}) { - readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'temperature'}.$si_units{tempC}[$hash->{units}]) - }elsif($jhash->{'tmp'}{'tC'}) { - readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'tmp'}{'tC'}.$si_units{tempC}[$hash->{units}]) - } - ; - readingsBulkUpdateMonitored($hash,"inttempStatus",$jhash->{'temperature_status'}) - if($jhash->{'temperature_status'}) ; - readingsBulkUpdateMonitored($hash,"overtemperature",$jhash->{'overtemperature'}) - if($jhash->{'overtemperature'}); - ############################################################################################################################# - #-- 1st generation: we have a switch type device and 'relay'-mode, e.g. shelly1, shelly1pm, shelly4, shelly2, shelly2.5, shellyplug or shellyem + fhem("deletereading $name error",1) if( ReadingsAge($name,"error",-1)>86400 ); # 24 hours / silent + #----------------------------------------------------------------------------------------- + #-- 1st generation: we have a switch type device and 'relay'-mode, e.g. shelly1, shelly1pm, shelly4, shelly2, shelly2.5, shellyplug or shellyem if( $shelly_models{$model}[0]>0 && $mode ne "roller" ){ - - my $metern = ($model =~ /shelly.?em/)?"emeters":"meters"; - + my $channels = $shelly_models{$model}[0]; for( my $i=0;$i<$channels;$i++){ $subs = ($channels == 1) ? "" : "_".$i; $ison = $jhash->{'relays'}[$i]{'ison'}; $ison =~ s/0|(false)/off/; $ison =~ s/1|(true)/on/; readingsBulkUpdateMonitored($hash,"relay".$subs,$ison); - + # for models with one relay: display state of relay as 'state' if( $shelly_models{$model}[0]==1 ){ readingsBulkUpdateMonitored($hash,"state",$ison); }else{ readingsBulkUpdateMonitored($hash,"state","OK"); } + + # timer if( $model ne "shelly4" ){ # readings not supported by Shelly4 v1.5.7 - readingsBulkUpdateMonitored($hash,"timer".$subs,$jhash->{'relays'}[$i]{'timer_remaining'}.$si_units{time}[$hash->{units}]); - if( $jhash->{'relays'}[$i]{'timer_remaining'}>0 ){ - $intervalN = minNum($intervalN,$jhash->{'relays'}[$i]{'timer_remaining'}); - } - $source = $jhash->{'relays'}[$i]{'source'}; + #-- source + $source = $jhash->{relays}[$i]{source}; readingsBulkUpdateMonitored($hash,"source".$subs,$source); + #-- timer + my $remaining = $jhash->{relays}[$i]{timer_remaining}; + readingsBulkUpdateMonitored($hash,"timer".$subs,$remaining.$si_units{time}[$hash->{units}]); + #-- nextUpdateTimer + if( $remaining>0 && AttrVal($name,'verbose',1) > 5 ){ + $intervalN = minNum($intervalN,$remaining+0.95); + readingsBulkUpdateMonitored($hash,"/_nextUpdateTimer",$intervalN.$si_units{time}[$hash->{units}]); + } + }else{ # Shelly4pro + my $onofftmr = 0; + if( $jhash->{relays}[$i]{has_timer} =~ /1|(true)/ ){ + $onofftmr = ReadingsNum($name,"auto_off".$subs,0) if( ReadingsNum($name,"timer".$subs,0)==0 ); + $onofftmr += ReadingsNum($name,"timer".$subs,0)-ReadingsAge($name,"timer".$subs,0); # interpolate remaining time + } + readingsBulkUpdateMonitored($hash,"timer".$subs,$onofftmr.$si_units{time}[$hash->{units}]); } } - - #-- we have a shellyuni device + + #-- we have a shellyuni device if($model eq "shellyuni") { - my $voltage = $jhash->{'adcs'}[0]{'voltage'}.$si_units{voltage}[$hash->{units}]; + my $voltage = $jhash->{adcs}[0]{voltage}.$si_units{voltage}[$hash->{units}]; readingsBulkUpdateMonitored($hash,"voltage",$voltage); } - ############################################################################################################################# + #----------------------------------------------------------------------------------------- #-- we have a shelly2 or shelly2.5 roller type device }elsif( ($model =~ /shelly2(\.5)?/) && ($mode eq "roller") ){ - Log3 $name,4,"[Shelly_proc1G] device $name with model=$model getting roller state "; + Log3 $name,4,"[Shelly_status1G] device $name with model=$model getting roller state "; + my $rollers = $shelly_models{$model}[1]; for( my $i=0;$i<$rollers;$i++){ $subs = ($rollers == 1) ? "" : "_".$i; - + #-- weird data: stop, close or open $rstate = $jhash->{'rollers'}[$i]{'state'}; $rstate =~ s/stop/stopped/; $rstate =~ s/close/drive-down/; $rstate =~ s/open/drive-up/; $hash->{MOVING} = $rstate; - $hash->{DURATION} = 0; - + #$hash->{DURATION} = 0; + #-- weird data: close or open $rlastdir = $jhash->{'rollers'}[$i]{'last_direction'}; $rlastdir =~ s/close/down/; $rlastdir =~ s/open/up/; $rstopreason = $jhash->{'rollers'}[$i]{'stop_reason'}; - + #-- open 100% or 0% ? $pctnormal = (AttrVal($name,"pct100","open") eq "open"); - + #-- possibly no data - $rcurrpos = $jhash->{'rollers'}[$i]{'current_pos'}; - - #-- we have data from the device, take that one + $rcurrpos = $jhash->{'rollers'}[$i]{'current_pos'}; + + #-- we have data from the device, take that one if( defined($rcurrpos) && ($rcurrpos =~ /\d\d?\d?/) ){ $pct = $pctnormal ? $rcurrpos : 100-$rcurrpos; $position = ($rcurrpos==100) ? "open" : ($rcurrpos==0 ? "closed" : $pct); - Log3 $name,5,"[Shelly_proc1G] device $name received roller position $rcurrpos, pct=$pct, position=$position (100% is ".AttrVal($name,"pct100","open").")"; + Log3 $name,5,"[Shelly_status1G] device $name received roller position $rcurrpos, pct=$pct, position=$position (100% is ".AttrVal($name,"pct100","open").")"; - #-- we have no data from the device + #-- we have no data from the device }else{ - Log3 $name,3,"[Shelly_proc1G] device $name with model=$model returns no blind position, consider chosing a different model=shelly2/2.5" - if( $model !~ /shelly2.*/ ); + Log3 $name,3,"[Shelly_status1G] device $name with model=$model returns no blind position, consider chosing a different model=shelly2/2.5" + if( $model !~ /shelly2.*/ ); $pct = ReadingsVal($name,"pct",undef); #-- we have a reading if( defined($pct) && $pct =~ /\d\d?\d?/ ){ $rcurrpos = $pctnormal ? $pct : 100-$pct; - $position = ($rcurrpos==100) ? "open" : ($rcurrpos==0 ? "closed" : $pct); + $position = ($rcurrpos==100) ? "open" : ($rcurrpos==0 ? "closed" : $pct); #-- we have no reading }else{ if( $rstate eq "stopped" && $rstopreason eq "normal"){ @@ -3035,147 +3224,154 @@ sub Shelly_proc1G { } } } - Log3 $name,3,"[Shelly_proc1G] device $name: no blind position received from device, we calculate pct=$pct, position=$position"; + Log3 $name,3,"[Shelly_status1G] device $name: no blind position received from device, we calculate pct=$pct, position=$position"; } $rstate = "pct-". 10*int($pct/10+0.5) if( $rstate eq "stopped" ); # format for state-Reading - + readingsBulkUpdateMonitored($hash,"state".$subs,$rstate); readingsBulkUpdateMonitored($hash,"pct".$subs,$pct); readingsBulkUpdateMonitored($hash,"position".$subs,$position); readingsBulkUpdateMonitored($hash,"stop_reason".$subs,$rstopreason); readingsBulkUpdateMonitored($hash,"last_dir".$subs,$rlastdir); } - ############################################################################################################################# - #-- we have a shellydimmer or shellyrgbw white device - }elsif( ($model eq "shellydimmer") || ($model eq "shellyrgbw" && $mode eq "white") ){ + #----------------------------------------------------------------------------------------- + #-- we have a lights device, eg shellydimmer, shellyrgbw, shellybulb or shellyduo + }elsif( $shelly_models{$model}[2] > 0 ){ + my $dimmers = $shelly_models{$model}[2]; + $dimmers = 1 if( $mode eq "color" ); for( my $i=0;$i<$dimmers;$i++){ $subs = (($dimmers == 1) ? "" : "_".$i); $ison = $jhash->{'lights'}[$i]{'ison'}; $ison =~ s/0|(false)/off/; $ison =~ s/1|(true)/on/; - my $bri = $jhash->{'lights'}[$i]{'brightness'}; + # colors + if( $mode eq "color" ){ + my $red = $jhash->{'lights'}[0]{'red'}; # 0 .... 255 + my $green = $jhash->{'lights'}[0]{'green'}; + my $blue = $jhash->{'lights'}[0]{'blue'}; + my $white = $jhash->{'lights'}[0]{'white'}; + my $gain = $jhash->{'lights'}[0]{'gain'}; # 0 .... 100 + Shelly_readingsBulkUpdate($hash,"gain",$gain.$si_units{pct}[$hash->{units}]); - readingsBulkUpdateMonitored($hash,"pct".$subs,$bri.$si_units{pct}[$hash->{units}]); - - readingsBulkUpdateMonitored($hash,"timer".$subs,$jhash->{'lights'}[$i]{'timer_remaining'}.$si_units{time}[$hash->{units}]); - if( $jhash->{'lights'}[$i]{'timer_remaining'}>0 ){ - $intervalN = minNum($intervalN,$jhash->{'lights'}[$i]{'timer_remaining'}); + if( defined $gain && $gain <= 100 ) { # != + $red = round($red*$gain/100.0 ,0); + $blue = round($blue*$gain/100.0 ,0); + $green = round($green*$gain/100.0,0); + } + Shelly_readingsBulkUpdate($hash,"L-red",$red); + Shelly_readingsBulkUpdate($hash,"L-green",$green); + Shelly_readingsBulkUpdate($hash,"L-blue",$blue); + Shelly_readingsBulkUpdate($hash,"L-white",$white); + Shelly_readingsBulkUpdate($hash,"rgb",sprintf("%02X%02X%02X", $red,$green,$blue)); + Shelly_readingsBulkUpdate($hash,"rgbw",sprintf("%02X%02X%02X%02X", $red,$green,$blue,$white)); + Shelly_readingsBulkUpdate($hash,"white",round($white/2.55,1).$si_units{pct}[$hash->{units}]); #percentual value + if(0){ + my ($hue,$sat,$bri) = Color::rgb2hsv($red/255,$green/255,$blue/255); + Shelly_readingsBulkUpdate($hash,"HSV",sprintf("%d,%4.1f,%4.1f",$hue*360,100*$sat,100*$bri)); # 'hsv' will have interference with widgets for white + } + # brightness (white-devices only) + }else{ + my $bri = $jhash->{'lights'}[$i]{'brightness'}; + readingsBulkUpdateMonitored($hash,"pct".$subs,$bri.$si_units{pct}[$hash->{units}]); } + + # effect + if( defined($jhash->{'lights'}[$i]{'effect'}) ){ + my $effect = $jhash->{'lights'}[$i]{'effect'}; # values: 0,1,2,3 + readingsBulkUpdateMonitored($hash,"effect".$subs, $effect ); + } + + # color-temperature ct + if( defined($jhash->{'lights'}[$i]{'temp'}) ){ # eg shellybulb in white-mode + my $ct = $jhash->{'lights'}[$i]{'temp'}; + readingsBulkUpdateMonitored($hash,"ct".$subs, $ct.$si_units{ct}[$hash->{units}]); + } + + # timer + my $remaining = $jhash->{'lights'}[$i]{'timer_remaining'}; + readingsBulkUpdateMonitored($hash,"timer".$subs,$remaining.$si_units{time}[$hash->{units}]); + $intervalN = minNum($intervalN,$remaining+0.95) if( $remaining>0 ); + readingsBulkUpdateMonitored($hash,"/_nextUpdateTimer",$intervalN.$si_units{time}[$hash->{units}]) + if( AttrVal($name,'timeout',undef) ); + + # source $source = $jhash->{'lights'}[$i]{'source'}; # 'timer' will occur as 'http' - readingsBulkUpdateMonitored($hash,"source".$subs,$source); - readingsBulkUpdateMonitored($hash,"light".$subs,$ison); # until 4.09a: "state" + readingsBulkUpdateMonitored($hash,"source".$subs,$source); + + # 'sub'-state of channels, reading is 'light_$i' + if(($model eq "shellydimmer") || ($model eq "shellyrgbw" && $mode eq "white")){ + readingsBulkUpdateMonitored($hash,"light".$subs,$ison); # until 4.09a: "state" + } } readingsBulkUpdateMonitored($hash,"state", ($dimmers > 1)?"OK":$ison); - - ############################################################################################################################# - #-- we have a shellybulb or shellyduo in white mode - }elsif( $model eq "shellybulb" && $mode eq "white" ){ - for( my $i=0;$i<$dimmers;$i++){ - $subs = (($dimmers == 1) ? "" : "_".$i); - $ison = $jhash->{'lights'}[$i]{'ison'}; - $ison =~ s/0|(false)/off/; - $ison =~ s/1|(true)/on/; - my $bri = $jhash->{'lights'}[$i]{'brightness'}; - my $ct = $jhash->{'lights'}[$i]{'temp'}; - readingsBulkUpdateMonitored($hash,"state".$subs,$ison); - readingsBulkUpdateMonitored($hash,"pct".$subs,$bri.$si_units{pct}[$hash->{units}]); - readingsBulkUpdateMonitored($hash,"ct".$subs, $ct.$si_units{ct}[$hash->{units}]); - - readingsBulkUpdateMonitored($hash,"timer",$jhash->{'lights'}[$i]{'timer_remaining'}.$si_units{time}[$hash->{units}]); - if( $jhash->{'lights'}[$i]{'timer_remaining'}>0 ){ - $intervalN = minNum($intervalN,$jhash->{'lights'}[$i]{'timer_remaining'}); - } - $source = $jhash->{'lights'}[$i]{'source'}; # Source 'timer' not supported by ShellyRGBW in color mode - readingsBulkUpdateMonitored($hash,"source",$source); - } - readingsBulkUpdateMonitored($hash,"state","OK") - if($dimmers > 1);#Log3 $name,0,"bulb dimmers $dimmers"; - ############################################################################################################################# - #-- we have a shellyrgbw color device - }elsif( $model =~ /shelly(rgbw|bulb)/ && $mode eq "color" ){ - $ison = $jhash->{'lights'}[0]{'ison'}; - $ison =~ s/0|(false)/off/; - $ison =~ s/1|(true)/on/; - my $red = $jhash->{'lights'}[0]{'red'}; # 0 .... 255 - my $green = $jhash->{'lights'}[0]{'green'}; - my $blue = $jhash->{'lights'}[0]{'blue'}; - my $white = $jhash->{'lights'}[0]{'white'}; - if(0){ - my ($hue,$sat,$bri) = Color::rgb2hsv($red/255,$green/255,$blue/255); - Shelly_readingsBulkUpdate($hash,"HSV",sprintf("%d,%4.1f,%4.1f",$hue*360,100*$sat,100*$bri)); # 'hsv' will have interference with widgets for white - } - my $gain = $jhash->{'lights'}[0]{'gain'}; # 0 .... 100 - Shelly_readingsBulkUpdate($hash,"gain",$gain.$si_units{pct}[$hash->{units}]); - - if( defined $gain && $gain <= 100 ) { # != - $red = round($red*$gain/100.0 ,0); - $blue = round($blue*$gain/100.0 ,0); - $green = round($green*$gain/100.0,0); - } - Shelly_readingsBulkUpdate($hash,"L-red",$red); - Shelly_readingsBulkUpdate($hash,"L-green",$green); - Shelly_readingsBulkUpdate($hash,"L-blue",$blue); - Shelly_readingsBulkUpdate($hash,"L-white",$white); - Shelly_readingsBulkUpdate($hash,"rgb",sprintf("%02X%02X%02X", $red,$green,$blue)); - Shelly_readingsBulkUpdate($hash,"rgbw",sprintf("%02X%02X%02X%02X", $red,$green,$blue,$white)); - - Shelly_readingsBulkUpdate($hash,"white",round($white/2.55,1).$si_units{pct}[$hash->{units}]); #percentual value - readingsBulkUpdateMonitored($hash,"state",$ison); - - $intervalN = $jhash->{'lights'}[0]{'timer_remaining'}; - $source = $jhash->{'lights'}[0]{'source'}; - readingsBulkUpdateMonitored($hash,"timer",$intervalN.$si_units{time}[$hash->{units}]); - readingsBulkUpdateMonitored($hash,"source",$source); - ############################################################################################################################# + Log3 $name,4,"[Shelly_status1G] finished processing lights-device $name is $model and mode is $mode. Next update in $intervalN seconds. "; + #----------------------------------------------------------------------------------------- }else{ - Log3 $name,5,"[Shelly_proc1G] Model of device $name is $model and mode is $mode. Updates every ".$hash->{INTERVAL}." seconds. "; + Log3 $name,5,"[Shelly_status1G] Model of device $name is $model and mode is $mode. Status updates every ".$hash->{INTERVAL}." seconds. "; readingsBulkUpdateMonitored($hash,"state","OK"); } - ############################################################################################################################# + #----------------------------------------------------------------------------------------- #-- common to all models - my $hasupdate = $jhash->{'update'}{'has_update'}; - my $firmware = $jhash->{'update'}{'old_version'}; - $firmware =~ /.*\/(v[0-9.]+(-rc\d|)).*/; + #- uptime + my $uptime = $jhash->{uptime}; + $uptime .= " sec, last reboot at ".FmtDateTime(time()-$uptime) if( [$hash->{units}] ); + readingsBulkUpdateIfChanged($hash,"uptime",$uptime); + + #- firmware + my $hasupdate = $jhash->{update}{has_update}; + my $updatestatus=$jhash->{update}{status}; # values of /ota call are: unknown, idle, pending, updating + my $firmware = $jhash->{update}{old_version}; + my $betafw = $jhash->{update}{beta_version}; + $firmware =~ /.*\/(v[0-9.]+(-rc\d|-\d|)).*/; # catching v1.12.1 or v1.12-1 or v1.12.1-rc1 $firmware = $1 if( length($1)>5 ); # very old versions don't start with v... if( $hasupdate ){ my $newfw = $jhash->{'update'}{'new_version'}; $newfw =~ /.*\/(v[0-9.]+(-rc\d|)).*/; - $newfw = $1; + $newfw = $1; $firmware .= "(update needed to $newfw)"; } - readingsBulkUpdateIfChanged($hash,"firmware",$firmware); - + readingsBulkUpdateIfChanged($hash,"firmware",$firmware); + readingsBulkUpdateIfChanged($hash,"firmware_beta",$betafw) if( $betafw ); + + if( $updatestatus ne "idle" ){ + readingsBulkUpdateIfChanged($hash,"update_status",$updatestatus); + }else{ + fhem("deletereading $name update_status"); + } + + #- cloud my $hascloud = $jhash->{'cloud'}{'enabled'}; if( $hascloud ){ my $hasconn = ($jhash->{'cloud'}{'connected'}) ? "connected" : "not connected"; - readingsBulkUpdateIfChanged($hash,"cloud","enabled($hasconn)"); + readingsBulkUpdateIfChanged($hash,"cloud","enabled($hasconn)"); }else{ - readingsBulkUpdateIfChanged($hash,"cloud","disabled"); + readingsBulkUpdateIfChanged($hash,"cloud","disabled"); } - - # coiot is updated by the settings call - #my $hascoiot = $jhash->{'coiot'}{'enabled'}; - #readingsBulkUpdateIfChanged($hash,"coiot",?"enabled":"disabled"); - - #readingsBulkUpdateIfChanged($hash,"coiot",defined($jhash->{'coiot'}{'enabled'})?"enabled":"disabled"); - - - #-- looking for metering values; common to all models with at least one metering channel - Log3 $name,4,"[Shelly_proc1G] $name: Looking for metering values"; + + #----------------------------------------------------------------------------------------- + #-- looking for metering values; common to all models with at least one metering channel + Log3 $name,4,"[Shelly_status1G] $name: Looking for metering values"; if( $shelly_models{$model}[3]>0 ){ + #-- how much meters ? + my $meters = $shelly_models{$model}[3]; + if( $mode eq "roller" ){ + #-- for roller devices, number of meters is equal to number of rollers + $meters = $shelly_models{$model}[1]; + }elsif( $mode eq "color" ){ + #-- Shelly RGBW in color mode has only one metering channel + $meters = 1; + } + #-- name of meters is different + my $metern = ($model =~ /shelly.?em/)?"emeters":"meters"; - #-- Shelly RGBW in color mode has only one metering channel - $meters = 1 if( $mode eq "color" ); - - my $metern = ($model =~ /shelly.?em/)?"emeters":"meters"; my $powerTTL =0; # we will increment by power value of each channel my $energyTTL=0; my $returnedTTL=0; - + #-----looping all meters of the device for( my $i=0;$i<$meters;$i++){ $subs = ($meters == 1) ? "" : "_".$i; - + #-- for roller devices store last power value (otherwise you mostly see nothing) if( $mode eq "roller" ){ $power = ReadingsNum($name,"power".$subs,0); @@ -3185,28 +3381,28 @@ sub Shelly_proc1G { ReadingsVal($name,"last_dir".$subs,""), # value undef, ReadingsTimestamp($name,"power".$subs,"") ) # timestamp - if( $power > 0 ); - } - + if( $power > 0 ); + } + #-- Power is provided by all metering devices, except Shelly1 (which has a power-constant in older fw) $power = $jhash->{$metern}[$i]{power}; readingsBulkUpdateMonitored($hash,"power".$subs,$power.$si_units{power}[$hash->{units}]); $powerTTL += $power; - + #-- Energy is provided except Shelly1 and Shellybulb/Vintage/Duo, ShellyUni if( defined($jhash->{$metern}[$i]{'total'}) ) { $energy = $jhash->{$metern}[$i]{'total'}; $energyTTL += $energy; $energy = shelly_energy_fmt($hash,$energy,$model =~ /shelly.?em/ ? "Wh" : "Wm" ); readingsBulkUpdateMonitored($hash,"energy".$subs,$energy); - Log3 $name,5,"[Shelly_proc1G] $name $subs: power=$power TTL=$powerTTL, energy=$energy TTL=$energyTTL"; + Log3 $name,5,"[Shelly_status1G] $name $subs: power=$power TTL=$powerTTL, energy=$energy TTL=$energyTTL"; } - + #-- Overpower: power value messured from device as overpowered, otherwise 0 (zero); not provided by all devices if( defined($jhash->{$metern}[$i]{'overpower'}) && $model !~ /rgbw/ ){ # 'defined' seems not working properly - $overpower = $jhash->{$metern}[$i]{'overpower'}; + $overpower = $jhash->{$metern}[$i]{'overpower'}; readingsBulkUpdateMonitored($hash,"overpower".$subs,$overpower.$si_units{power}[$hash->{units}]); - #-- for Shelly.EM or ShellyRGBW use boolean state of relay instead + #-- for Shelly.EM or ShellyRGBW use boolean state of relay instead }elsif( $i>=0 && $model !~ /bulb/ && $model ne "shelly1" ){ if( defined($jhash->{'relays'}[$i]{'overpower'}) ){ $overpower = $jhash->{'relays'}[$i]{'overpower'}; # true if device was overpowered, otherwise false @@ -3225,23 +3421,23 @@ sub Shelly_proc1G { my $energy_returned = $jhash->{$metern}[$i]{'total_returned'}; $returnedTTL += $energy_returned; #readingsBulkUpdateMonitored($hash,"energy_returned".$subs,shelly_energy_fmt($hash,$energy_returned,"Wh")); - readingsBulkUpdateMonitored($hash,"energyReturned".$subs,shelly_energy_fmt($hash,$energy_returned,"Wh")); - + readingsBulkUpdateMonitored($hash,"energyReturned".$subs,shelly_energy_fmt($hash,$energy_returned,"Wh")); + my $voltage = $jhash->{$metern}[$i]{'voltage'}; readingsBulkUpdateMonitored($hash,'voltage'.$subs,$voltage.$si_units{voltage}[$hash->{units}]); - + my ($pfactor,$freq,$current); my $apparentPower=0; my $reactivePower=0; # apparent power = Scheinleistung # reactive power = Blindleistung - + if( defined($jhash->{$metern}[$i]{'reactive'}) ){ #reactive power only provided by ShellyEM $reactivePower = $jhash->{$metern}[$i]{'reactive'}; # calculate Apparent Power and Power Factor $apparentPower = sprintf("%4.1f",sqrt( ($power * $power) + ($reactivePower * $reactivePower) )); $pfactor = ($apparentPower != 0)?(int($power / $apparentPower * 100) / 100):"0"; - } + } if( defined($jhash->{$metern}[$i]{'pf'}) ){ #power factor only provided by Shelly3EM $pfactor = $jhash->{$metern}[$i]{'pf'}; $apparentPower = sprintf("%4.1f",$power / $pfactor) if( $pfactor !=0 ); @@ -3250,7 +3446,7 @@ sub Shelly_proc1G { $current = $jhash->{$metern}[$i]{'current'}; readingsBulkUpdateMonitored($hash,'current'.$subs,$current.$si_units{current}[$hash->{units}]); } - $freq = $jhash->{$metern}[$i]{'freq'}; + $freq = $jhash->{$metern}[$i]{'freq'}; readingsBulkUpdateMonitored($hash,'powerFactor'.$subs,$pfactor); readingsBulkUpdateMonitored($hash,'frequency'.$subs,$freq) if( defined($freq) ); # supported from fw 1.0.0 readingsBulkUpdateMonitored($hash,'apparentpower'.$subs,$apparentPower.$si_units{apparentpower}[$hash->{units}]); @@ -3258,7 +3454,7 @@ sub Shelly_proc1G { } } #-- end looping all meters if( $meters>1 ){ #write out values for devices with more than one meter - if( defined($jhash->{'total_power'}) ){ #not provided by Shelly4 + if( defined($jhash->{'total_power'}) ){ #not provided by Shelly4 readingsBulkUpdateMonitored($hash,"power_TTL",$jhash->{'total_power'}.$si_units{power}[$hash->{units}]); } readingsBulkUpdateMonitored($hash,"energy_TTL",shelly_energy_fmt($hash,$energyTTL,$model =~ /shelly.?em/ ? "Wh" : "Wm")); @@ -3266,7 +3462,7 @@ sub Shelly_proc1G { # readingsBulkUpdateMonitored($hash,"energy_returned_TTL",shelly_energy_fmt($hash,$returnedTTL,"Wh")); readingsBulkUpdateMonitored($hash,"energyReturned_TTL",shelly_energy_fmt($hash,$returnedTTL,"Wh")); #---try to calculate an energy balance - readingsBulkUpdateMonitored($hash,"Total_Energy",shelly_energy_fmt($hash,$energyTTL-$returnedTTL,"Wh")); + readingsBulkUpdateMonitored($hash,"Total_Energy",shelly_energy_fmt($hash,$energyTTL-$returnedTTL,"Wh")); #--- #-- the calculated total power value may be obsolete, if always equal to the read total_power (see above) readingsBulkUpdateMonitored($hash,"power_TTLc",$powerTTL.$si_units{power}[$hash->{units}]); @@ -3276,20 +3472,20 @@ sub Shelly_proc1G { readingsBulkUpdateMonitored($hash,"power_TTL",$powerTTL.$si_units{power}[$hash->{units}]); } } - } - + } + #----------------------------------------------------------------------------------------- #looking for inputs if( AttrVal($name,"showinputs","show") eq "show" && defined($jhash->{'inputs'}[0]{'input'}) ){ # check if there is at least one input available my ($subs, $ison, $event, $event_cnt); my $inpn=$shelly_models{$model}[5]; #number of inputs my $i=0; - while( $i<$inpn ){ + while( $i<$inpn ){ $subs = ($inpn==1?"":"_$i"); # subs $ison = $jhash->{'inputs'}[$i]{'input'}; $ison = "unknown" if(length($ison)==0); $ison =~ s/0|(false)/off/; $ison =~ s/1|(true)/on/; - Log3 $name,5,"[Shelly_proc1G] $name has input $i with state \"$ison\" "; + Log3 $name,5,"[Shelly_status1G] $name has input $i with state \"$ison\" "; readingsBulkUpdateMonitored($hash,"input".$subs,$ison); # if( $ison ); ## button $event = $jhash->{'inputs'}[$i]{'event'}; $event_cnt = $jhash->{'inputs'}[$i]{'event_cnt'}; @@ -3300,625 +3496,1525 @@ sub Shelly_proc1G { #readingsBulkUpdateMonitored($hash,"input$subs\_cnt",$event_cnt,1) if( $event_cnt ); readingsBulkUpdateMonitored($hash,"input$subs\_cnt",$event_cnt) if( $event_cnt ); - if( defined($jhash->{'inputs'}[$i]{'last_sequence'}) && $jhash->{'inputs'}[$i]{'last_sequence'} eq "" && $model eq "shellyi3" ){ - # for a shellyi3 with an input configured as TOGGLE this reading is empty - fhem("deletereading $name input$subs\_.*"); + if(0 && defined($jhash->{'inputs'}[$i]{'last_sequence'}) && $jhash->{'inputs'}[$i]{'last_sequence'} eq "" && $model eq "shellyi3" ){ + # for a shellyi3 with an input configured as TOGGLE this reading is empty + fhem("deletereading $name input$subs\_.*"); } $i++; } } - + #----------------------------------------------------------------------------------------- + #-- for all models set internal temperature reading and status + if( $jhash->{'temperature'} ){ + readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'temperature'}.$si_units{tempC}[$hash->{units}]); + }elsif( $jhash->{'tmp'}{'tC'} ){ + readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'tmp'}{'tC'}.$si_units{tempC}[$hash->{units}]); + } + readingsBulkUpdateMonitored($hash,"inttempStatus",$jhash->{'temperature_status'}) + if($jhash->{'temperature_status'}) ; + readingsBulkUpdateMonitored($hash,"overtemperature",$jhash->{'overtemperature'}) + if($jhash->{'overtemperature'}); #-- look for external sensors - if($jhash->{'ext_temperature'}) { + if( $jhash->{'ext_temperature'} ){ my %sensors = %{$jhash->{'ext_temperature'}}; foreach my $temp (keys %sensors){ - readingsBulkUpdateMonitored($hash,"temperature_".$temp,$sensors{$temp}->{'tC'}.$si_units{tempC}[$hash->{units}]); + readingsBulkUpdateMonitored($hash,"temperature_".$temp,$sensors{$temp}->{'tC'}.$si_units{tempC}[$hash->{units}]); } } - if($jhash->{'ext_humidity'}) { + if( $jhash->{'ext_humidity'} ){ my %sensors = %{$jhash->{'ext_humidity'}}; foreach my $hum (keys %sensors){ - readingsBulkUpdateMonitored($hash,"humidity_".$hum,$sensors{$hum}->{'hum'}.$si_units{relHumidity}[$hash->{units}]); + readingsBulkUpdateMonitored($hash,"humidity_".$hum,$sensors{$hum}->{'hum'}.$si_units{humidity}[$hash->{units}]); } } #-- look if name of Shelly has been changed - if( defined($jhash->{'name'}) ){#&& AttrVal($name,"ShellyName","") ne $jhash->{'name'} ){ #ShellyName we don't have this reading here! + if( defined($jhash->{'name'}) ){ readingsBulkUpdateIfChanged($hash,"name",$jhash->{'name'} ); - #$attr{$hash->{NAME}}{ShellyName} = $jhash->{'name'}; } + # calibration status + my $calib = $jhash->{calibrated}; + if( defined($calib) ){ + $calib =~ s/0|(false)/no/; + $calib =~ s/1|(true)/yes/; + readingsBulkUpdateMonitored($hash,"calibrated",$calib); + } + #----------------------------------------------------------------------------------------- readingsEndUpdate($hash,1); - - return $intervalN; -} + # nextUpdate + $hash->{helper}{timer} = $intervalN; # we set timer also by Shelly_status() + if( $hash->{INTERVAL}>0 ){ + #-- initiate next run + RemoveInternalTimer($hash,"Shelly_status"); + InternalTimer(time()+$intervalN, "Shelly_status", $hash); + Log3 $name,4,"[Shelly_status1G] $name: next \'/status\' update in $intervalN seconds"; #4 + #-- call settings + if( time()-$hash->{helper}{settings_time} > 36.00 ){ + Shelly_HttpRequest( $hash,"/settings",undef,"Shelly_settings1G" ); + } + } +} #END Shelly_status1G + ######################################################################################## -# -# Shelly_proc2G - process data from device 2nd generation -# Necessary because in 2G devices status are per channel +# +# Shelly_settings1G - process data from device 1st generation +# /settings call # ######################################################################################## - -sub Shelly_proc2G { - my ($hash, $comp, $jhash) = @_; - $hash->{units}=0 if( !defined($hash->{units}) ); - my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; + +sub Shelly_settings1G { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $name = $hash->{NAME}; + my $model = AttrVal($name,"model","generic"); + + my $reqestcall = $param->{cmd}; + Log3 $name,4,"[Shelly_settings1G] $name: processing JSON-Hash from \'$reqestcall\' call";#4 + my ($chn,$i,$subs,$onoff,$val); + + readingsBeginUpdate($hash); + + #----------------------------------------------------------------------------------------- + if( $reqestcall eq "/settings" ){ + + ### Wifi Access Point + my $ap_ssid = $jhash->{wifi_ap}{ssid}; + if( $ap_ssid ){ + my $ap_key = $jhash->{wifi_ap}{key}; + my $ap_is_open = ($ap_key eq ""?"open":"password"); + + my $ap_enabled = $jhash->{wifi_ap}{enabled}; + $ap_enabled =~ s/(true|1)/enabled/; + $ap_enabled =~ s/(false|0)/disabled/; + + readingsBulkUpdateIfChanged($hash,"ap","$ap_ssid $ap_enabled $ap_is_open"); + } + + ### Restricted Login + my $restricted_login = $jhash->{login}{enabled}; + $restricted_login =~ s/(true|1)/username:password/; + $restricted_login =~ s/(false|0)/open/; + readingsBulkUpdateIfChanged($hash,"login",$restricted_login); + my $username = $jhash->{login}{username}; + my $msg="username:password"; + if(0&& $restricted_login eq "open" ){ + if( $username eq AttrVal($name,"shellyuser","") ){ + $msg="attribute shellyuser is defined, but restricted login is not enabled"; + }else{ + $msg="attribute shellyuser is different from Shellies username"; + } + readingsBulkUpdateIfChanged($hash,"login","$msg"); + } + + + + my $profile = $jhash->{mode}; # all Gen1 devices with relays or lights (except Shelly4pro) have this reading, even single-mode devices + if( !defined($profile) ){ + if( $model eq "shellyi3" ){ + $profile = "input"; + }else{ + $profile = "relay"; #AttrVal($name,"mode",""); + } + } + Log3 $name,4,"[Shelly_settings1G] the mode of device $name is \'$profile\'"; + + #-- we have a switch type device and 'relay'-mode, e.g. shelly1, shelly1pm, shelly4pro, shelly2, shelly2.5, shellyplug or shellyem + if( $shelly_models{$model}[0]>0 && $profile ne "roller" ){ # relay-devices + $chn = $shelly_models{$model}[0]; + for( $i=0;$i<$chn;$i++ ){ + $subs = ($chn>1 ? "_$i" : "" ); + # when an on/off value is given, then the on/off function is enabled, otherwise disabled + # when enabled, the default value is 30 sec + foreach $onoff ("on","off"){ + $val=$jhash->{relays}[$i]{"auto_$onoff"}; + $val=$val?$val.$si_units{time}[$hash->{units}]:"0 - disabled"; + Shelly_readingsBulkUpdate($hash,"auto_$onoff$subs",$val); + } + $val = $jhash->{relays}[$i]{name}; # relay name; don't use Umlaute + Shelly_readingsBulkUpdate($hash,"relay$subs\_name",$val) if( defined($val) ); + } + + #-- we have a shellyuni device + if($model eq "shellyuni") { + my $val; + foreach my $relay ( 0, 1 ){ + $val = sprintf("over %3.3f %s %s, under %3.3f %s %s", + $jhash->{adcs}[0]{relay_actions}[$relay]{over_threshold}/1000, + $si_units{voltage}[$hash->{units}], + $jhash->{adcs}[0]{relay_actions}[$relay]{over_act}, + $jhash->{adcs}[0]{relay_actions}[$relay]{under_threshold}/1000, + $si_units{voltage}[$hash->{units}], + $jhash->{adcs}[0]{relay_actions}[$relay]{under_act} + ); + $val =~ s/_/ /; # substitue underline by space + $val = "disabled" if( $val !~ /relay/ ); + readingsBulkUpdateMonitored($hash,"relay_$relay\_adcs_action",$val); + } + } + #----------------------------------------------------------------------------------------- + }elsif($shelly_models{$model}[2]>0){ # lights-devices + # + #-- Shellybulbs, ShellyRGBW + $chn = $shelly_models{$model}[2]; + $chn = 1 if( AttrVal($name,"mode", "color") eq "color" ); + for( $i=0;$i<$chn;$i++ ){ + $subs = ($chn>1 ? "_$i" : "" ); + # transition -- transition time (in milli-seconds) + $val = $jhash->{lights}[$i]{transition}; # 0 .... 5000 + if( defined($val) ){ + Shelly_readingsBulkUpdate($hash,"transition$subs",$val.$si_units{time_ms}[$hash->{units}]); + } + # auto_on, auto_off -- default timer in seconds + foreach $onoff ("on","off"){ + $val=$jhash->{lights}[$i]{"auto_$onoff"}; + $val=$val?$val.$si_units{time}[$hash->{units}]:"0 - disabled"; + Shelly_readingsBulkUpdate($hash,"auto_$onoff$subs",$val); + } + } + # effect: ShellyRGBW2 in color mode + $val = $jhash->{lights}[0]{effect}; + if( defined($val) ){ + Shelly_readingsBulkUpdate($hash,"effect",$val); # no subs + } + #-- Shellydimmer + $val = $jhash->{transition}; + if( defined($val) ){ + readingsBulkUpdateMonitored($hash,"transition", $val.$si_units{time_ms}[$hash->{units}]); + } + } + #----------------------------------------------------------------------------------------- + # common to all 1G-devices + # coiot + my $coiot = $jhash->{coiot}{enabled}; + $coiot = $jhash->{coiot_execute_enable} if( !defined($coiot) ); # old fw of shelly4 + readingsBulkUpdateIfChanged($hash,"coiot",$coiot==1?"enabled":"disabled"); + readingsBulkUpdateIfChanged($hash,"coiot_period", + defined($jhash->{coiot}{update_period})?$jhash->{coiot}{update_period}.$si_units{time}[$hash->{units}]:"disabled"); + # ap-roaming + my $ap_roaming = $jhash->{ap_roaming}{enabled}; + if( defined($ap_roaming) ){ + if( $ap_roaming == 1 ){ + $ap_roaming = $jhash->{ap_roaming}{threshold}.$si_units{rssi}[$hash->{units}]; + }else{ + $ap_roaming = "disabled"; + } + readingsBulkUpdateIfChanged($hash,"network_wifi_roaming",$ap_roaming); + } + # name + readingsBulkUpdateIfChanged($hash,"name",$jhash->{name} ) + if( defined($jhash->{name}) ); + # MAC - will be captured by 'get model' + + my %comp = ( # name of the reading where to find input's settings + # profile # component + "relay" => "relays", + "roller" => "rollers", + "white" => "lights", + "color" => "lights", + "input" => "inputs" + ); + my $dev = $comp{$profile}; + + Log3 $name,4,"[Shelly_settings1G] $name: getting input-settings as model $model from: /$dev/channel"; + + #Inputs: settings regarding the input + if( AttrVal($name,"showinputs","show") eq "show" && $shelly_models{$model}[5]>0 ){ + my ($btn_type,$invert,$in_mode,$in_swap); + my $i=0; + + if( $profile eq "roller"){ + + $btn_type = $jhash->{rollers}[0]{button_type}; # toggle, momentary, detached + + $invert = $jhash->{rollers}[0]{btn_reverse}; + $invert =~ s/0/straight/; # 0=(false) = not inverted + $invert =~ s/1/inverted/; # 1=(true) + + $in_mode = $jhash->{rollers}[0]{input_mode}; # roller: single=onebutton, dual=openclose + $in_mode =~ s/openclose/dual/; + $in_mode =~ s/onebutton/single/; + + $in_swap = $jhash->{rollers}[0]{swap_inputs}; + $in_swap =~ s/0/normal/; # 0=(false) = not swapped + $in_swap =~ s/1/swapped/; # 1=(true) + + Log3 $name,4,"[Shelly_settings1G] $name: writing input-settings to inputs\_mode=$btn_type $invert $in_mode $in_swap"; + readingsBulkUpdateMonitored($hash,"inputs\_mode","$btn_type $invert $in_mode $in_swap"); + + }else{ + while( defined($jhash->{$dev}[$i]{btn_type}) ){ + $subs = $shelly_models{$model}[5]==1?"":"_$i"; + $subs ="s" if( $model eq "shellydimmer" ); + + # btn_type: toggle, momentary, detached, ... + $btn_type = $jhash->{$dev}[$i]{btn_type}; + + # btn_reverse: 0, 1 + if( defined($jhash->{$dev}[$i]{btn_reverse}) ){ # not supported by older fw (eg shelly4pro) + $invert = $jhash->{$dev}[$i]{btn_reverse}; + $invert =~ s/0/straight/; # 0=(false) = not inverted + $invert =~ s/1/inverted/; # 1=(true) + }else{ + $invert = ""; + } + if( $model eq "shellydimmer" ){ + $in_swap = $jhash->{$dev}[0]{swap_inputs}; + $in_swap =~ s/0/normal/; # 0=(false) = not swapped + $in_swap =~ s/1/swapped/; # 1=(true) + }else{ + $in_swap = ""; + } + Log3 $name,4,"[Shelly_settings1G] $name: writing input-settings to input$subs\_mode=$btn_type $invert $in_swap"; + readingsBulkUpdateMonitored($hash,"input$subs\_mode","$btn_type $invert $in_swap"); + $i++; + } + } + } + #----------------------------------------------------------------------------------------- + Shelly_HttpRequest( $hash,"/settings/actions",undef,"Shelly_settings1G",undef,1 ); # we use the 'val' parameter to get the call silent (no screen message) + + # get actions + }elsif( $reqestcall eq "/settings/actions" ){ + # call: /settings/actions + my $silent=0; # defined($param->{val})?1:0;#Debug "silent 1G $name=$silent="; + my $info=0; + $silent= 1 if( defined($param->{val}) && $param->{val}==1); + $info = 1 if( defined($param->{val}) && $param->{val}==2); # we never use this + $info=0; + #Debug "$name: silent=$silent, info=$info"; + my ($e,$i,$u,$event); + my $a=0; # count quantity of actions, works as an index + my $count=0; # count quantity of URLs + my $enabled=0; # count quantity of enabled URLs/actions + my $unused=0; # count quantity of unused actions + my $msg = "check & update actions on device $name:"; + if( $shelly_events{$model}[0] ne "" ){ + $msg ="NameChannel "; + $msg.="Index URLEN/DIS" unless( $info ); + $msg.=""; + my $url; + foreach my $m ($model,"addon1"){ + # parsing %shelly_events + for( $e=0; $event = $shelly_events{$m}[$e] ; $e++ ){ + for( $i=0; defined($jhash->{actions}{$event}[$i]{index}) ;$i++ ){ + for( $u=0; $u<5 ; $u++ ){ + $url=$jhash->{actions}{$event}[$i]{urls}[$u]; + if( $info ){ + $msg.="$event   $i  "; + }elsif( defined($url) ){ + $msg.="$event   $i  "; + $msg.=" $u  $url  " ; + $count++; + if( $jhash->{actions}{$event}[$i]{enabled} == 1 ){ + $enabled++ ; + $msg .= "EN"; + }else{ + $msg .= "DIS"; + } + $msg .=""; + }elsif( $u == 0 ){ + $unused++; + $msg.="$event   $i $u no URL defined"; + } + last if( $info ); # quit the loop + } + $a++; # increment + # last if( $info ); # quit the loop + } + } + } + $msg .= ""; + unless( $info ){ + $msg .= "   "; + $msg .= "Total actions $a "; + $msg .= "Total URLs $count   "; + $msg .= "Unused actions $unused "; + $msg .= "Enabled actions $enabled "; + } + $msg =~ s/%20/ /g; + $msg = "$msg
"; + } + readingsBulkUpdateIfChanged($hash,"webhook_cnt",$enabled); + if( $info ){ + ##FW_directNotify(undef,"#FHEMWEB:WEB","FW_okDialog( \"meine msg\" )", ""); + + readingsBulkUpdateIfChanged($hash,"webhooks_info",$msg); + }else{ + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"$msg\" )", "") if($silent == 0); + } + } + #----------------------------------------------------------------------------------------- + readingsEndUpdate($hash,1); + $hash->{helper}{settings_time}=time(); +} # END Shelly_settings1G() + + + +######################################################################################## +# +# Shelly_status2G - process status data from device 2nd generation +# called by: /rpc/Shelly.GetStatus +# +######################################################################################## + +sub Shelly_status2G { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $name = $hash->{NAME}; + my $comp = $param->{comp}; + + my $state = $hash->{READINGS}{state}{VAL}; my $model = AttrVal($name,"model","generic"); my $mode = AttrVal($name,"mode",""); - - my $channel = undef; - $channel = $jhash->{'id'} if( $comp eq "relay" || $comp eq "roller" || $comp eq "input" ); - my $rollers = $shelly_models{$model}[1]; - my $dimmers = $shelly_models{$model}[2]; - - my $meters = $mode eq "roller" ? $shelly_models{$model}[1] : $shelly_models{$model}[3]; - # my $meters = $shelly_models{$model}[3]; - - my ($subs,$ison,$overpower,$voltage,$current,$power,$energy,$pfactor,$freq,$minutes,$errors); ##R minutes errors + + my ($channels,$channel,$id); + + # $channel = $jhash->{'id'} if( $comp eq "relay" || $comp eq "roller" || $comp eq "input" ); + ##my $dimmers = $shelly_models{$model}[2]; + + my ($subs,$ison,$overpower,$voltage,$current,$power,$energy,$ret_energy,$pfactor,$freq,$minutes,$errors); ##R minutes errors my $timer = $hash->{INTERVAL}; # check we have a second gen device - if( $shelly_models{$model}[4]==0 && !$comp ){ - Log3 $name,2,"[Shelly_proc2G] ERROR: calling Proc2G for a not 2ndGen Device"; + if( $shelly_models{$model}[4]==0 ){ + Log3 $name,2,"[Shelly_status2G] ERROR: calling status2G for a not 2ndGen Device"; return undef; } - - Log3 $name,4,"[Shelly_proc2G] device $name of model $model processing component $comp"; - + + Log3 $name,4,"[Shelly_status2G] device $name of model $model processing one-in-all status call "; + readingsBeginUpdate($hash); - - if($shelly_models{$model}[0]>1 && ($shelly_models{$model}[1]==0 || $mode eq "relay")){ - readingsBulkUpdate($hash,"state","OK",1); #set state for multichannel relay-devices; for rollers state is 'stopped' or 'drive...' - } - ############retrieving the relay state for relay - if( $shelly_models{$model}[0]>0 && $comp eq "relay"){ - Log3 $name,4,"[Shelly_proc2G:relay] Processing relay state for device $name channel/id $channel, comp is $comp"; - $subs = ($shelly_models{$model}[0] == 1) ? "" : "_".$channel; - $ison = $jhash->{'output'}; + + ############ Processing system values. ############################## + ############ Available for all Gen2 devices (exceptions are marked *) + Log3 $name,4,"[Shelly_status2G:sys] $name: Processing sys values"; + + ############ checking if cloud is connected + #Note: check if cloud is allowed will result from configuration + if(ReadingsVal($name,"cloud","none") !~ /disabled/){ + my $hasconn = $jhash->{cloud}{connected}; + Log3 $name,5,"[Shelly_proc2G:status] $name: hasconn=" . ($hasconn?"true":"false"); + $hasconn = $hasconn ? "connected" : "not connected"; + readingsBulkUpdateIfChanged($hash,"cloud","enabled($hasconn)"); + } + ############ checking if MQTT is connected + # my $hasconn = $jhash->{mqtt}{connected} ? 'connected' : 'disconnected'; + + ############ checking Blootooth BLE + + ############ checking Websocket WS + + ############ checking if firmware update is available + my $update = $jhash->{sys}{available_updates}{stable}{version}; + my $upd_beta= $jhash->{sys}{available_updates}{beta}{version}; + my $firmware = ReadingsVal($name,"firmware","none"); # eg 1.2.5(update.... + if( $firmware =~ /^(.*?)\(/ ){ + $firmware = $1; + } + my $txt = ($firmware =~ /beta/ )?"update possible to latest stable v":"update needed to v"; + if( $update ){ #stable + Log3 $name,5,"[Shelly_status2G:sys] $name: available: $update, current in device: $firmware"; + $firmware .= "($txt$update)" if( $firmware ne "v$update" ); + }elsif($upd_beta){ # maybe there is a beta version available + Log3 $name,5,"[Shelly_status2G:sys] $name: $firmware --> $upd_beta"; + $firmware .= "(update possible to v$upd_beta)"; + }else{ + my $latest_known = $model =~ /walldisplay/ ? $shelly_firmware{walldisplay} : $shelly_firmware{gen2}; + Log3 $name,5,"[Shelly_status2G:sys] $name: $firmware no stable update, no beta update available"; + if( $firmware !~ $latest_known ){ + $firmware .= "(check internet for firmware $latest_known)"; + } + } + readingsBulkUpdateIfChanged($hash,"firmware",$firmware); + + ############ checking if connected to LAN. Is similiar given as answer to /rpc/Eth.GetStatus + my $eth_ip = "-"; + my $netw_subs = ""; + if( ReadingsVal($name,"model_family","unknown") =~ /Pro/ ){ + $eth_ip = $jhash->{eth}{ip} if( defined($jhash->{eth}{ip}) ); + readingsBulkUpdateIfChanged($hash,"network_ip-address_LAN",$eth_ip ); + $netw_subs = "_Wifi"; + } + + ############ checking if connected to Wifi. Is similiar given as answer to /rpc/Wifi.GetStatus + my ($wifi_ip,$wifi_ssid,$wifi_rssi); + my $wifi_status= $jhash->{wifi}{status}; # disconnected, got ip + if( $wifi_status eq "got ip" ){ + $wifi_ip = $jhash->{wifi}{sta_ip}; + $wifi_ssid = $jhash->{wifi}{ssid}; + $wifi_rssi = Shelly_rssi($hash,$jhash->{wifi}{rssi}); + }else{ + $wifi_ip = "-"; + $wifi_ssid = "-"; + $wifi_rssi = "-"; + } + readingsBulkUpdateIfChanged($hash,"network_ip-address".$netw_subs,$wifi_ip ); + readingsBulkUpdateIfChanged($hash,"network_ssid",$wifi_ssid); + readingsBulkUpdateIfChanged($hash,"network_rssi",$wifi_rssi); + + if( $eth_ip eq "-" && $wifi_ssid eq "-" ){ # disconnected + Shelly_error_handling($hash,"Shelly_status2G:status","not connected",2); + }else{ + if( $eth_ip ne "-" && $wifi_ssid eq "-" ){ + $netw_subs = "(LAN)"; + }elsif( $eth_ip eq "-" && $wifi_ssid ne "-" ){ + $netw_subs = "(Wifi)"; + }elsif( $eth_ip eq $hash->{DEF} && $wifi_ssid ne "-" ){ + $netw_subs = "(LAN)"; + }elsif( $eth_ip ne "-" && $wifi_ip eq $hash->{DEF} ){ + $netw_subs = "(Wifi)"; + }else{ # LAN or Wifi - we don't know + $netw_subs = ""; + } + readingsBulkUpdateIfChanged($hash,"network","connected to {DEF}."\">".$hash->{DEF}." $netw_subs"); + } + Log3 $name,4,"[Shelly_status2G:network] $name ethernet=$eth_ip,wifi=$wifi_ssid @ $wifi_rssi"; + + + ############ checking uptime + my $uptime = $jhash->{sys}{uptime}; + $uptime .= " sec, last reboot at ".FmtDateTime(time()-$uptime) if( $hash->{units} ); + readingsBulkUpdateIfChanged($hash,"uptime",$uptime); + + ############ checking webhook version + my $webhook_rev = $jhash->{sys}{webhook_rev}; + readingsBulkUpdateIfChanged($hash,"webhook_ver",$webhook_rev); + + ############ Processing input states ############################### + #Inputs in button-mode (Taster) CANNOT be read out! + #Inputs of cover devices are strongly attached to the device. + $channels = $shelly_models{$model}[5]; # number of inputs + if( $channels>0 ){ + Log3 $name,5,"[Shelly_status2G:input] Processing $channels input states for device $name ($model)"; + + for($channel=0; $channel<$channels; $channel++){ + Log3 $name,4,"[Shelly_status2G:input] Processing state of input $channel for device $name"; + $id = $jhash->{"input:$channel"}{id}; + $subs = ($channels == 1) ? "" : "_".$channel; + $ison = defined($jhash->{"input:$channel"}{state})?$jhash->{"input:$channel"}{state}:"unknown"; $ison =~ s/0|(false)/off/; $ison =~ s/1|(true)/on/; - readingsBulkUpdateMonitored($hash,"relay".$subs,$ison); + readingsBulkUpdateMonitored($hash,"input".$subs,$ison); + } + if( $model eq "shellyplusuni" ){ + # has input:2 as counter + $channel=2; + $id = $jhash->{"input:$channel"}{id}; + $subs = ($channels == 1) ? "" : "_".$channel; + #-- get values + my $cnts_ttl = $jhash->{"input:$channel"}{counts}{total}; + my $cnts_xttl = $jhash->{"input:$channel"}{counts}{xtotal}; + my $cnts_byminute = $jhash->{"input:$channel"}{counts}{by_minute}[0]; + my $cnts_xbyminute = $jhash->{"input:$channel"}{counts}{xby_minute}[0]; + my $minute_ts = $jhash->{"input:$channel"}{counts}{minute_ts}; + my $freq = $jhash->{"input:$channel"}{freq}; + #-- set readings + readingsBulkUpdateMonitored($hash,"input".$subs,$cnts_ttl); + readingsBulkUpdateMonitored($hash,"input".$subs,$cnts_xttl); + readingsBulkUpdateMonitored($hash,"input".$subs,$cnts_byminute); + readingsBulkUpdateMonitored($hash,"input".$subs,$cnts_xbyminute); + readingsBulkUpdateMonitored($hash,"input".$subs,$minute_ts); #timestamp + readingsBulkUpdateMonitored($hash,"input".$subs,$freq.$si_units{frequency}[$hash->{units}]); + ##### + # may have input:100 as analog input + $channel=100; + $id = $jhash->{"input:$channel"}{id}; + $subs = "_".$channel; + #-- get values + my $percent = $jhash->{"input:$channel"}{percent}; + if( defined $percent ){ + readingsBulkUpdateMonitored($hash,"input".$subs,$percent.$si_units{pct}[$hash->{units}]); + } + } + # set state of 'input-only' devices to OK (may have state 'error') + readingsBulkUpdateMonitored($hash,"state","OK") if( $model eq "shellyplusi4" ); + } + ############ processing light device ############################### + $channels = $shelly_models{$model}[2]; # number of dimmers + if( $channels>0 ){ + $comp="light"; + Log3 $name,4,"[Shelly_status2G:light] Processing $channels light states for device $name ($model)"; + + for($channel=0; $channel<$channels; $channel++){ + Log3 $name,5,"[Shelly_status2G:light] Processing state of dimmer $channel for device $name "; + $id = $jhash->{"light:$channel"}{id}; + $subs = ($channels == 1) ? "" : "_".$channel; + $ison = $jhash->{"light:$channel"}{output}; + $ison =~ s/0|(false)/off/; + $ison =~ s/1|(true)/on/; + readingsBulkUpdateMonitored($hash,"light".$subs,$ison); + + # brightness (white-devices only) + my $bri = $jhash->{"light:$channel"}{brightness}; + readingsBulkUpdateMonitored($hash,"pct".$subs,$bri.$si_units{pct}[$hash->{units}]); + + # processing timers, if present (see also 'emeters') + if( $jhash->{"light:$channel"}{timer_started_at} ){ + Log3 $name,5,"[Shelly_status2G:light] $name processing timer of light device"; + $hash->{NextUpdate} = $jhash->{"light:$channel"}{timer_started_at} + $jhash->{"light:$channel"}{timer_duration}; + $timer = $hash->{NextUpdate} - time(); + $timer = round($timer,1); + readingsBulkUpdateMonitored($hash,"timer".$subs,$timer.$si_units{time}[$hash->{units}]." = ".FmtDateTime($hash->{NextUpdate})); + }elsif(ReadingsVal($name,"timer$subs",undef) ){ + readingsBulkUpdateMonitored($hash,"timer".$subs,'-'); + } + + # processing transition time + if( $jhash->{"light:$channel"}{transition}{started_at} ){ + my $tran_start = $jhash->{"light:$channel"}{transition}{started_at}; + my $tran_duration = $jhash->{"light:$channel"}{transition}{duration}; + my $tran_remaining= round($tran_start + $tran_duration - time() , 3); + readingsBulkUpdateMonitored($hash,"transition_timer".$subs,$tran_remaining.$si_units{time}[$hash->{units}]); + readingsBulkUpdateMonitored($hash,"transition_target".$subs,$jhash->{"light:$channel"}{transition}{target}{brightness}.$si_units{pct}[$hash->{units}]); + } + # Switch Reason: Trigger for switching # --> init, http <-fhemWEB, WS_in, timer, loopback (=schedule?), HTTP <-Shelly-App - readingsBulkUpdateMonitored($hash,"source".$subs,$jhash->{'source'}); - - readingsBulkUpdateMonitored($hash,"state",($shelly_models{$model}[0] == 1)?$ison:"OK"); + readingsBulkUpdateMonitored($hash,"source".$subs,$jhash->{"light:$channel"}{source}); + } + #set state for multichannel light-devices to "OK" + readingsBulkUpdateMonitored($hash,"state",($channels == 1)?$ison:"OK"); + } + ############ processing relay states ############################### + $channels = $shelly_models{$model}[0]; # number of relays + if( $channels>0 && $mode ne "roller" ){ + $comp="switch"; + Log3 $name,4,"[Shelly_status2G:switch] Processing $channels relay states for device $name ($model as $mode)"; - ############retrieving the roller state and position - }elsif( $rollers>0 && $comp eq "roller") { - Log3 $name,4,"[Shelly_proc2G:roller] Processing roller state for device $name (we have $rollers rollers)"; - my ($rsource,$rstate,$raction,$rcurrpos,$rtargetpos,$position,$pct,$pctnormal); - my $rlastdir = "unknown"; - #for( my $i=0;$i<$rollers;$i++){ - my $id=$jhash->{'id'}; - $subs = ($rollers == 1) ? "" : "_".$id; + for($channel=0; $channel<$channels; $channel++){ + $id = $jhash->{"switch:$channel"}{id}; + $subs = ($channels == 1) ? "" : "_".$channel; + $ison = $jhash->{"switch:$channel"}{output}; + $ison =~ s/0|(false)/off/; + $ison =~ s/1|(true)/on/; + Log3 $name,4,"[Shelly_status2G:switch] Setting state of relay $channel for device $name to \'$ison\'"; + readingsBulkUpdateMonitored($hash,"relay".$subs,$ison); + + # Switch Reason: Trigger for switching + # --> init, http <-fhemWEB, WS_in, timer, loopback (=schedule?), HTTP <-Shelly-App + readingsBulkUpdateMonitored($hash,"source".$subs,$jhash->{"switch:$channel"}{source}); + } + #set state for multichannel relay-devices to "OK" + readingsBulkUpdateMonitored($hash,"state",($channels == 1)?$ison:"OK"); + } + ############ processing roller states and position ############################### + $channels = $shelly_models{$model}[1]; # number of rollers + if( $channels>0 && $mode ne "relay"){ + $comp="cover"; + for($channel=0; $channel<$channels; $channel++){ + Log3 $name,5,"[Shelly_status2G:cover] Processing roller state for device $name channel $channel (we have $channels rollers)"; + $id = $jhash->{"cover:$channel"}{id}; + my ($rsource,$rstate,$raction,$rcurrpos,$rtargetpos,$position,$pct,$pctnormal); + my $rlastdir = "unknown"; + $subs = ($channels == 1) ? "" : "_".$channel; #roller: check reason for moving or stopping: http, timeout *), WS_in, limit-switch,obstruction,overpower,overvoltage ... # and safety_switch (if Safety switch is enabled in Shelly -> see Cover.GetConfig) #timeout: either a) calculated moving-time given by target-pos or b) configured maximum moving time - $rsource = $jhash->{'source'}; - $rstate = $jhash->{'state'}; # returned values are: stopped, closed, open, closing, opening + $rsource = $jhash->{"cover:$channel"}{source}; + $rstate = $jhash->{"cover:$channel"}{state}; # returned values are: stopped, closed, open, closing, opening if( $rstate eq "closing" ){ $raction = "start"; $rstate = "drive-down"; $rlastdir= "down"; # Last direction: not supported by "Cover.GetStatus" }elsif( $rstate eq "opening"){ - $raction = "start"; + $raction = "start"; $rstate = "drive-up"; - $rlastdir= "up"; + $rlastdir= "up"; }else{ # "stopped" "closed" "open" $raction = "stop"; $rstate = "stopped"; } - readingsBulkUpdateMonitored($hash,$raction."_reason".$subs,$rsource); # readings start_reason & stop_reason + readingsBulkUpdateMonitored($hash,$raction."_reason".$subs,$rsource); # readings start_reason & stop_reason readingsBulkUpdateMonitored($hash,"last_dir".$subs,$rlastdir) if($rlastdir ne "unknown"); - $hash->{MOVING} = $rstate; - $hash->{DURATION} = 0; - Log3 $name,4,"[Shelly_proc2G] Roller id=$id action=$raction state=$rstate Last dir=$rlastdir"; + $hash->{MOVING} = $rstate; + #$hash->{DURATION} = 0; + Log3 $name,4,"[Shelly_status2G:cover] Roller id=$channel action=$raction state=$rstate Last dir=$rlastdir"; #-- for roller devices store last power & current value (otherwise you mostly see nothing) if( $mode eq "roller" ){ $power = ReadingsNum($name,"power".$subs,0); - Shelly_readingsBulkUpdate($hash,"power_last".$subs, + Shelly_readingsBulkUpdate($hash,"power_last".$subs, $power.$si_units{power}[$hash->{units}]." ". ReadingsVal($name,"last_dir".$subs,""), undef, ReadingsTimestamp($name,"power".$subs,"") ) if( $power > 0 ); $current = ReadingsNum($name,"current".$subs,0); - Shelly_readingsBulkUpdate($hash,"current_last".$subs, + Shelly_readingsBulkUpdate($hash,"current_last".$subs, $current.$si_units{current}[$hash->{units}]." ". ReadingsVal($name,"last_dir".$subs,""), undef, ReadingsTimestamp($name,"current".$subs,"") ) - if( $current > 0 ); + if( $current > 0 ); } # Power in Watts - $power = $jhash->{'apower'}.$si_units{power}[$hash->{units}]; + $power = $jhash->{"cover:$channel"}{apower}.$si_units{power}[$hash->{units}]; readingsBulkUpdateMonitored($hash,"power".$subs,$power); - Log3 $name,4,"[Shelly_proc2G] Roller reading power$subs=$power"; + Log3 $name,4,"[Shelly_status2G:cover] Roller reading power$subs=$power"; #-- open 100% or 0% ? $pctnormal = (AttrVal($name,"pct100","open") eq "open"); - + # Receiving position of Cover, we always receive a current position of the cover, but sometimes position is lost - if( defined($jhash->{'current_pos'}) ){ - $rcurrpos = $jhash->{'current_pos'}; + if( defined($jhash->{"cover:$channel"}{current_pos}) ){ + $rcurrpos = $jhash->{"cover:$channel"}{current_pos}; $pct = $pctnormal ? $rcurrpos : 100-$rcurrpos; - $position = ($rcurrpos==100) ? "open" : ($rcurrpos==0 ? "closed" : $pct); - $rstate = "pct-". 10*int($pct/10+0.5) if( $rstate eq "stopped" ); # format for state-Reading + $position = ($rcurrpos==100) ? "open" : ($rcurrpos==0 ? "closed" : $pct); + $rstate = "pct-". 10*int($pct/10+0.5) if( $rstate eq "stopped" ); # format for state-Reading }else{ $pct = "unknown"; $position = "position lost"; $rstate = "Error: position"; } - Log3 $name,4,"[Shelly_proc2G] Roller id=$id position is $position $pct"; + Log3 $name,4,"[Shelly_status2G:cover] Roller id=$id position is $position $pct"; readingsBulkUpdateMonitored($hash,"pct".$subs,$pct); readingsBulkUpdateMonitored($hash,"position".$subs,$position); readingsBulkUpdateMonitored($hash,"state".$subs,$rstate); - - ############retrieving EM power values rpc/EM.GetStatus?id=0 - }elsif($comp eq "EM"){ - Log3 $name,4,"[Shelly_proc2G:EM] Processing Power Metering (EM) state for device $name"; - my $suffix = AttrVal($name,"EMchannels","_ABC"); - - my ($pr,$ps,$reading,$value); - my ($power,$aprt_power,$reactivePower); - - foreach my $emch ( "a_","b_","c_","total_" ){ - if( $suffix eq "ABC_" || $suffix eq "L123_" ){ - $pr=$mapping{sf}{$suffix}{$emch}; - $ps=""; - }else{ - $pr=""; - $ps=$mapping{sf}{$suffix}{$emch}; - } - $reading=$pr.$mapping{E1}{current}.$ps; - $value =sprintf("%5.3f%s",$jhash->{$emch.'current'},$si_units{current}[$hash->{units}]); - readingsBulkUpdateMonitored($hash,$reading,$value); - - $reading=$pr.$mapping{E1}{aprt_power}.$ps; - $aprt_power=$jhash->{$emch.'aprt_power'}; - $value =sprintf("%4.1f%s",$jhash->{$emch.'aprt_power'}, $si_units{apparentpower}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,$reading,$value); - - $reading=$pr.$mapping{E1}{act_power}.$ps; - $power=$jhash->{$emch.'act_power'}; - $value =sprintf("%5.1f%s",$jhash->{$emch.'act_power'}, $si_units{power}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,$reading,$value); # store this also as helper -if(0){ # check calculation of reactive power! - $reading=$pr.$mapping{E1}{react_power}.$ps; - $value = ($aprt_power * $aprt_power) - ($power * $power); - $reactivePower = ($value<=>0)*sqrt( abs($value) ); - $value = sprintf("%4.1f%s",$reactivePower, $si_units{reactivepower}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,$reading,$value); -} - if($emch ne "total_"){ - # to get latest values when calculating total pushed value - $hash->{helper}{$emch.'Active_Power'}=$jhash->{$emch.'act_power'}; - - $reading=$pr.$mapping{E1}{voltage}.$ps; - $value =sprintf("%4.1f%s",$jhash->{$emch.'voltage'},$si_units{voltage}[$hash->{units}]); - readingsBulkUpdateMonitored($hash,$reading,$value); - - $reading=$pr.$mapping{E1}{pf}.$ps; - $value = $jhash->{$emch.'pf'}; - $value = sprintf("%4.2f%s",abs($value),( abs($value)==1?"":" (".( $value<0 ? $mapping{E1}{cap}:$mapping{E1}{ind}).")")); - readingsBulkUpdateMonitored($hash,$reading,$value); - - $reading=$pr.$mapping{E1}{frequency}.$ps; - $value = $jhash->{$emch.'freq'}; - readingsBulkUpdateMonitored($hash,$reading,$value.$si_units{frequency}[$hash->{units}]) if( defined($value) ); # supported from fw 1.0.0 - - $power += $jhash->{$emch.'act_power'}; - } - } - - ### Balancing: cumulate power values and save them in helper, will be used by Shelly_EMData() - $hash->{helper}{powerCnt}++; - $hash->{helper}{power} += $power; - $hash->{helper}{powerPos} += $power if($power>0); - $hash->{helper}{powerNeg} -= $power if($power<0); # the cumulated value is positive! - - readingsBulkUpdateMonitored($hash,"state","OK"); - - - ############retrieving input states rpc/Input.GetStatus?id= - }elsif( $comp eq "input" ){ - Log3 $name,4,"[Shelly_proc2G:input] Processing input state for device $name channel/id $channel"; - $subs = ($shelly_models{$model}[5] == 1) ? "" : "_".$channel; - $ison = defined($jhash->{'state'})?$jhash->{'state'}:"unknown"; - $ison =~ s/0|(false)/off/; - $ison =~ s/1|(true)/on/; - readingsBulkUpdateMonitored($hash,"input".$subs,$ison); - - }elsif( $comp eq "status" ){ - #processing the answer rpc/Shelly.GetStatus from shelly_shelly(): - Log3 $name,4,"[Shelly_proc2G:status] $name: Processing the answer rpc/Shelly.GetStatus from Shelly_shelly()"; - # in this section we read (as far as available): - # cloud:connected: - # sys:available_updates:stable:version - # sys:available_updates:beta:version - # eth:ip: - # wifi:sta_ip: - # wifi:status: - # wifi:ssid: - # wifi:rssi: - # input:$i:id: - # input:$i:state: - - #checking if cloud is connected - #Note: check if cloud is allowed will result from configuration - if(ReadingsVal($name,"cloud","none") !~ /disabled/){ - my $hasconn = ($jhash->{'cloud'}{'connected'}); - Log3 $name,5,"[Shelly_proc2G:status] $name: hasconn=" . ($hasconn?"true":"false"); - $hasconn = $hasconn ? "connected" : "not connected"; - readingsBulkUpdateIfChanged($hash,"cloud","enabled($hasconn)"); - } - #checking if updates are available - # /rpc/Shelly.GetDeviceInfo/fw_id - # /ver firmware version - # /name name of Shelly - # /rpc/Shelly.GetConfig/sys:device:fw_id - # /rpc/Shelly.GetStatus/sys:available_updates:beta:version only when there is a beta version - # /rpc/Shelly.GetStatus/available_updates {} - my $update = $jhash->{'sys'}{'available_updates'}{'stable'}{'version'}; - my $firmware = ReadingsVal($name,"firmware","none"); # eg 1.2.5(update.... - if( $firmware =~ /^(.*?)\(/ ){ - $firmware = $1; - } - my $txt = ($firmware =~ /beta/ )?"update possible to latest stable v":"update needed to v"; - if( $update ){ #stable - Log3 $name,5,"[Shelly_proc2G:status] $name: $txt$update current in device: $firmware"; - $firmware .= "($txt$update)"; - readingsBulkUpdateIfChanged($hash,"firmware",$firmware); - }else{ # maybe there is a beta version available - $update = $jhash->{'sys'}{'available_updates'}{'beta'}{'version'}; - if( $update ){ - Log3 $name,5,"[Shelly_proc2G:status] $name: $firmware --> $update beta"; - $firmware .= "(update possible to v$update beta)"; - readingsBulkUpdateIfChanged($hash,"firmware",$firmware); - } - } - - #checking if connected to wifi / LAN - #is similiar given as answer to rpc/Wifi.GetStatus - - my $eth_ip = $jhash->{'eth'}{'ip'} ? $jhash->{'eth'}{'ip'} : "-"; - my $wifi_ssid = $jhash->{'wifi'}{'ssid'} ? $jhash->{'wifi'}{'ssid'} : "-"; - my $wifi_rssi = ($jhash->{'wifi'}{'rssi'} ? $jhash->{'wifi'}{'rssi'} : "-"); - readingsBulkUpdateIfChanged($hash,"network_ssid",$wifi_ssid); - readingsBulkUpdateIfChanged($hash,"network_rssi",Shelly_rssi($hash,$wifi_rssi) ); - - #my $wifi_status= $jhash->{'wifi'}{'status'}; # sometimes not supported by ShellyWallDisplay fw 1.2.4 - if( $eth_ip ne "-" && $wifi_ssid ne "-" ){ - readingsBulkUpdateIfChanged($hash,"network","connected to ".$eth_ip." (LAN, Wifi)"); - }elsif( $eth_ip ne "-" && $wifi_ssid eq "-" ){ - readingsBulkUpdateIfChanged($hash,"network","connected to ".$eth_ip." (LAN)"); - }elsif( $eth_ip eq "-" && $wifi_ssid ne "-" ){ - my $wifi_ip = $jhash->{'wifi'}{'sta_ip'}; - readingsBulkUpdateIfChanged($hash,"network","connected to ".$wifi_ip." (Wifi)"); - }else{ - Shelly_error_handling($hash,"Shelly_proc2G:status","not connected"); - } - Log3 $name,4,"[Shelly_proc2G:status] $name ethernet=$eth_ip,wifi=$wifi_ssid @ $wifi_rssi"; - - #Inputs in button-mode (Taster) CANNOT be read out! - #Inputs of cover devices are strongly attached to the device. - #Following we assume that number of inputs is equal to number of relays. - my ($subs, $ison); - my $i=0; - if( AttrVal($name,"showinputs","show") eq "show" && $shelly_models{$model}[5]>0 ){ - - while( defined($jhash->{"input:$i"}{'id'}) ){ - $subs = $shelly_models{$model}[5]==1?"":"_$i"; - $ison = $jhash->{"input:$i"}{'state'}; - $ison = "unknown" if( !defined($ison) ); - $ison = "unknown" if( length($ison)==0 ); - $ison =~ s/0|(false)/off/; - $ison =~ s/1|(true)/on/; - Log3 $name,5,"[Shelly_proc2G:status] $name has input $i with state $ison"; - readingsBulkUpdateMonitored($hash,"input".$subs,$ison) if( $ison ); - $i++; - } - readingsBulkUpdateMonitored($hash,"state","OK") if( $model eq "shellyplusi4" ); } - - # ******** - if( $model =~ /walldisplay/ ){ + } + + ############ processing internal temperature ############################### + if( defined($jhash->{"$comp:0"}{temperature}{tC}) ){ + # most Gen2 devices have internal temperature on each channel, eg. {light:1}{temperature}{tC} + # we use only channel :0 + readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{"$comp:0"}{temperature}{tC}.$si_units{tempC}[$hash->{units}]); + Log3 $name,5,"[Shelly_status2G:inttemp] $name processed internal temperature"; + }elsif( $model eq "shellypro3em" ){ + my $value = $jhash->{'temperature:0'}{tC}; + readingsBulkUpdateMonitored($hash,"inttemp",$value.$si_units{tempC}[$hash->{units}]); + Log3 $name,5,"[Shelly_status2G:inttemp] $name processed internal temperature"; + }else{ + # internal temperature not provided by all devices + Log3 $name,5,"[Shelly_status2G:inttemp] $name no internal temperature for $model ($comp) found"; + } + + ############ processing Walldisplay ambient readings ############################### + if( $model =~ /walldisplay/ ){ + $comp = "walldisplay"; $subs =""; # readings supported by the /Shelly.GetStatus call or by individual calls eg /Temperature.GetStatus readingsBulkUpdateMonitored($hash,"temperature" .$subs,$jhash->{'temperature:0'}{'tC'}.$si_units{tempC}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,"humidity" .$subs,$jhash->{'humidity:0'}{'rh'}.$si_units{relHumidity}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,"illuminance" .$subs,$jhash->{'illuminance:0'}{'lux'}.$si_units{illum}[$hash->{units}] ); - readingsBulkUpdateMonitored($hash,"illumination".$subs,$jhash->{'illuminance:0'}{'illumination'} ); - } - # ******** - # look for sensor addon - my $t=100; - while( $jhash->{"temperature:$t"}{id} ){ - $subs = "_".($jhash->{"temperature:$t"}{id}-100); - readingsBulkUpdateMonitored($hash,"temperature" .$subs,$jhash->{"temperature:$t"}{'tC'}.$si_units{tempC}[$hash->{units}] ); - $t++; - } - - ################ Shelly.GetConfig - }elsif($comp eq "config"){ - Log3 $name,4,"[Shelly_proc2G:config] $name: processing the answer rpc/Shelly.GetConfig from Shelly_shelly()"; + readingsBulkUpdateMonitored($hash,"humidity" .$subs,$jhash->{'humidity:0'}{'rh'}.$si_units{humidity}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,"illuminance" .$subs,$jhash->{'illuminance:0'}{'lux'}.$si_units{illuminance}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,"illumination".$subs,$jhash->{'illuminance:0'}{'illumination'} ); + } - #Cloud - my $hascloud = $jhash->{'cloud'}{'enable'}; + ############ processing Shelly Plus Sensor Addon ############################### Y175 + if( ReadingsVal($name,"addon","none") eq "sensor" ){ + Log3 $name,4,"[Shelly_status2G:addon] $name: processing Shelly Plus Sensor Addon"; + my %addon = ( + # keys are Shellies components + # values are: JSON-key, max number of sensors + "temperature"=> ["tC",5], + "humidity" => ["rh",1], + "input" => [undef,2], # analog or digital ! + "voltmeter" => ["voltage",1] + ); + foreach my $sensor( keys %addon ){ + for( $channel=100; $channel<(100+$addon{$sensor}[1]) ; $channel++ ){ + # Debug $sensor.":".$jhash->{"$sensor:$channel"}{'id'}." - ".$channel; + next unless $jhash->{"$sensor:$channel"}{'id'}; + Log3 $name,4,"[Shelly_status2G:addon] $name: processing Add On for $sensor: channel=$channel"; + $subs = $jhash->{"$sensor:$channel"}{id}-100; + if( $sensor eq "input" ){ + $subs += $shelly_models{$model}[5]; # number of 'regular' inputs + $subs = "_".$subs; + if( $jhash->{"$sensor:$channel"}{percent} ){ # channel is analog input + readingsBulkUpdateMonitored($hash,$sensor.$subs,$jhash->{"$sensor:$channel"}{percent}.$si_units{pct}[$hash->{units}] ); + }else{ # channel is digital input + my $ison = $jhash->{"$sensor:$channel"}{state}; + $ison =~ s/0|(false)/off/; + $ison =~ s/1|(true)/on/; + readingsBulkUpdateMonitored($hash,$sensor.$subs,$ison ); + } + }else{ + readingsBulkUpdateMonitored($hash,$sensor."_".$subs,$jhash->{"$sensor:$channel"}{($addon{$sensor}[0])}.$si_units{$sensor}[$hash->{units}] ); + } + } + } + } + + ############ processing energy meter readings ############################### + # common to roller and relay, also ShellyPMmini energymeter, but not: Walldisplay + # get number of metering channels + $channels = $shelly_models{$model}[3]; # number of metering channels + $channels = $shelly_models{$model}[1] if( $mode eq "roller" ); + + $comp = "pm1" if( $model eq "shellypmmini" ); + $comp = "em" if( $model eq "shellypro3em" ); + + if( $comp eq "light" || $comp eq "cover" || $comp eq "switch" || $comp eq "pm1" ){ + + for( $channel=0; $channel<$channels; $channel++){ + my $CC = "$comp:$channel"; + my $id = $jhash->{$CC}{id}; + $subs = ( $mode eq "roller" ? $shelly_models{$model}[1] : $shelly_models{$model}[3])==1?"":"_$id"; + Log3 $name,5,"[Shelly_status2G:emeter] $name: Processing metering channel$subs"; + + $voltage = $jhash->{$CC}{voltage}.$si_units{voltage}[$hash->{units}]; + $current = $jhash->{$CC}{current}.$si_units{current}[$hash->{units}]; + $power = $jhash->{$CC}{apower} .$si_units{power}[$hash->{units}]; # active power + + $energy = $jhash->{$CC}{aenergy}{total}; + $ret_energy= $jhash->{$CC}{ret_aenergy}{total}; + # Energy consumption by minute (in Milliwatt-hours) for the last minute + $minutes = shelly_energy_fmt($hash,$jhash->{$CC}{aenergy}{by_minute}[0],"mWh"); # is cumulated while minute restarts + + Log3 $name,5,"[Shelly_status2G:emeter] $name $comp voltage$subs=$voltage, current$subs=$current, power$subs=$power"; #4 + + readingsBulkUpdateMonitored($hash,"voltage".$subs,$voltage); + readingsBulkUpdateMonitored($hash,"current".$subs,$current); + readingsBulkUpdateMonitored($hash,"power" .$subs,$power); + # PowerFactor not supported by ShellyPlusPlugS, ShellyPMmini and others + readingsBulkUpdateMonitored($hash,"pfactor".$subs,$jhash->{$CC}{pf}) if( defined($jhash->{$CC}{pf}) ); + + # frequency supported from fw 1.0.0 + readingsBulkUpdateMonitored($hash,"frequency".$subs,$jhash->{$CC}{freq}.$si_units{frequency}[$hash->{units}]) + if( defined($jhash->{$CC}{freq}) ); + + readingsBulkUpdateMonitored($hash,"energy" .$subs,shelly_energy_fmt($hash,$energy,"Wh")); + if( defined($ret_energy) ){ # available with suitable devices/mode only, eg. ShellyPro1PM + readingsBulkUpdateMonitored($hash,"energy_returned" .$subs,shelly_energy_fmt($hash,$ret_energy,"Wh")); + readingsBulkUpdateMonitored($hash,"energy_purchased".$subs,shelly_energy_fmt($hash,$energy-$ret_energy,"Wh")); + } + + #readingsBulkUpdateMonitored($hash,"energy_lastMinute".$subs,$minutes); + readingsBulkUpdateMonitored($hash,"state",$power) if($model eq "shellypmmini"); + + # protection: checking for overload errors + $errors = $jhash->{$CC}{errors}[0]; + $errors = "none" if(!$errors); + #readingsBulkUpdateMonitored($hash,"errors".$subs,$errors); + readingsBulkUpdateMonitored($hash,"protection".$subs,$errors); + + # processing timers, if present (not provided by Walldisplay) + if( $jhash->{$CC}{timer_started_at} ){ + Log3 $name,5,"[Shelly_status2G:timer] $name processing timer"; + if( $jhash->{$CC}{timer_remaining} ){ + $timer = $jhash->{$CC}{timer_remaining}; + Log3 $name,5,"[Shelly_status2G:timer] $name remaining timer$subs is $timer"; + }else{ + $timer = $jhash->{$CC}{timer_started_at} + $jhash->{$CC}{timer_duration} - time(); + $timer = round($timer,1); + Log3 $name,5,"[Shelly_status2G:timer] $name calculated timer$subs from start and duration is $timer"; + } + readingsBulkUpdateMonitored($hash,"timer".$subs,$timer.$si_units{time}[$hash->{units}]); + }elsif(ReadingsVal($name,"timer$subs",undef) ){ + readingsBulkUpdateMonitored($hash,"timer".$subs,'-'); + } + + # calculate all periods, when given by attribute + my @TPs=split(/,/x, AttrVal($name,"Periods", "") ); + #$unixtime = $unixtime-$unixtime%60; # adjust to lass full minute + my $unixtime = time(); + #$TimeStamp = FmtDateTime($unixtime-$unixtime%60); # adjust to lass full minute + my $TimeStamp = FmtDateTime( time() ); + foreach my $TP (@TPs){ + Log3 $name,5,"[Shelly_status2G:periods] $name: calling shelly_delta_energy for period \'$TP\' "; + shelly_delta_energy($hash,"energy_",$TP,$unixtime,$energy,$TimeStamp,fhem('{$isdst}',1)); + } + #--- + } # END of metering channels loop + }elsif( $comp eq "em" ){ + Log3 $name,5,"[Shelly_status2G:emeter] $name is of model $model and component $comp: processing errors (if any)";#5 + my $errors = undef; + my $suffix = AttrVal($name,"EMchannels","_ABC"); + foreach my $emch ( "a_","b_","c_","total_" ){ + # checking for em-channel errors + # may contain: power_meter_failure, no_load + if( defined($jhash->{'em:0'}{$emch.'errors'}[0]) ){ + $errors .= $mapping{sf}{$suffix}{$emch}.$jhash->{'em:0'}{$emch.'errors'}[0]; + } + } + # checking for EM-system errors + # may contain: power_meter_failure, phase_sequence (eg if a phase is switched off), no_load + if( $jhash->{'em:0'}{errors}[0] ){ + $errors .= "System: ".$jhash->{'em:0'}{errors}[0]; + } + readingsBulkUpdateMonitored($hash,"error_EM",defined($errors)?$errors:"ok"); + }else{ + Log3 $name,5,"[Shelly_status2G:emeter] $name is of model $model and component $comp: skipped metering";#5 + } + #-------------------------------------------------------------------------------- + readingsEndUpdate($hash,1); + + fhem("deletereading $name error",1) if( ReadingsAge($name,"error",-1)>36000 ); # delete after 10 hours, silent + + if( $hash->{NextUpdate} ){ + my $remaining = $hash->{NextUpdate} - time(); + if( $hash->{INTERVAL}>0 && ($hash->{INTERVAL}+5)<$remaining){ + $timer = $hash->{INTERVAL}; + }else{ + $timer = round(maxNum($remaining,0.75),2); # take at least 0.75sec if remaining time is small or negative + delete $hash->{NextUpdate}; + } + } + readingsSingleUpdate($hash,"/_nextUpdateTimer",$timer.$si_units{time}[$hash->{units}],1) + if( AttrVal($name,'timeout',undef) ); ## for debugging only + + if( $hash->{INTERVAL}>0 ){ + #-- initiate next run + RemoveInternalTimer($hash,"Shelly_status"); + InternalTimer(time()+$timer, "Shelly_status", $hash); + Log3 $name,4,"[Shelly_status2G] $name: next \'GetStatus\' update in $timer seconds"; #4 + #-- call settings + if( time()-$hash->{helper}{settings_time} > 36.00 ){ + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetConfig",undef,"Shelly_settings2G","config" ); + } + } +} # END Shelly_status2G() + + +######################################################################################## +# +# Shelly_settings2G - process config/settings data from device 2nd generation +# +######################################################################################## + +sub Shelly_settings2G { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $comp = $param->{comp}; + my $name = $hash->{NAME}; + my $model= AttrVal($name,"model","generic"); + my $subs; + my $range_extender_enable; + + # check we have the comp parameter + if( !$comp ){ + Log3 $name,2,"[Shelly_settings2G] ERROR: calling Shelly_settings2G(), but no component given"; + return undef; + } + # check we have a second gen device + if( $shelly_models{$model}[4]==0 ){ + Log3 $name,2,"[Shelly_settings2G] ERROR: calling Shelly_settings2G(), but $name is not a 2ndGen Device"; + return undef; + } + Log3 $name,4,"[Shelly_settings2G] device $name of model $model processing component $comp"; + readingsBeginUpdate($hash); + + ################ Shelly.GetConfig + if($comp eq "config"){ + Log3 $name,4,"[Shelly_settings2G:config] $name: processing the answer /rpc/Shelly.GetConfig"; + + ### checking bluetooth ble + my $ble = $jhash->{ble}{enable}; + $ble = defined($ble) ? "enabled" : " disabled"; + readingsBulkUpdateIfChanged($hash,"ble",$ble); + + ### Cloud + my $hascloud = $jhash->{cloud}{enable}; Log3 $name,5,"[Shelly_proc2G:config] $name: hascloud=" . ($hascloud?"true":"false"); if(!$hascloud ){ # cloud disabled readingsBulkUpdateIfChanged($hash,"cloud","disabled"); }elsif(ReadingsVal($name,"cloud","none") !~ /enabled/){ readingsBulkUpdateIfChanged($hash,"cloud","enabled"); } - #show Wifi roaming threshold only when connected via wifi - if( $jhash->{'wifi'}{'roam'}{'rssi_thr'} && ReadingsVal($name,"network_ssid","-") ne "-"){ - readingsBulkUpdateIfChanged($hash,"network_threshold",$jhash->{'wifi'}{'roam'}{'rssi_thr'}.$si_units{rssi}[$hash->{units}]); + ### show Wifi roaming threshold only when connected via wifi + if( $jhash->{wifi}{roam}{rssi_thr} && ReadingsVal($name,"network_ssid","-") ne "-"){ + ## readingsBulkUpdateIfChanged($hash,"network_wifi_roaming",$jhash->{wifi}{roam}{rssi_thr}.$si_units{rssi}[$hash->{units}]); + } + #********** + # ap-roaming + my $ap_roaming = $jhash->{wifi}{roam}{interval}; + if( defined($ap_roaming) ){ + if( $ap_roaming > 0 ){ + $ap_roaming = $jhash->{wifi}{roam}{rssi_thr}.$si_units{rssi}[$hash->{units}]; + }else{ + $ap_roaming = "disabled"; + } + readingsBulkUpdateIfChanged($hash,"network_wifi_roaming",$ap_roaming); + } + #********** + + ### Access Point network, range extender + my $ap = $jhash->{wifi}{ap}{ssid}; + if( $ap ){ + my $ap_is_open = $jhash->{wifi}{ap}{is_open}; + $ap_is_open =~ s/(true|1)/open/; + $ap_is_open =~ s/(false|0)/password/; + + my $ap_enable = $jhash->{wifi}{ap}{enable}; + $ap_enable =~ s/(true|1)/enabled/; + $ap_enable =~ s/(false|0)/disabled/; + + readingsBulkUpdateIfChanged($hash,"ap","$ap $ap_enable $ap_is_open"); + + my $extender = $jhash->{wifi}{ap}{range_extender}{enable}; + $extender =~ s/(true|1)/enabled/; + $extender =~ s/(false|0)/disabled/; + readingsBulkUpdateIfChanged($hash,"ap_clients",$extender); } - #Inputs: settings regarding the input + ### Inputs: settings regarding the input if( AttrVal($name,"showinputs","show") eq "show" && $shelly_models{$model}[5]>0 ){ - my $profile = $jhash->{'sys'}{'device'}{'profile'}; # switch, cover - $profile = "switch" if( !$profile ) ; - my ($subs, $input); - my ($invert,$in_mode, $in_swap); - my $i=0; + my $profile = $jhash->{sys}{device}{profile}; # switch, cover - while( defined($jhash->{"input:$i"}{'id'}) ){ - $subs = $shelly_models{$model}[5]==1?"":"_$i"; - $input = $jhash->{"input:$i"}{'type'}; - $invert = $jhash->{"input:$i"}{'invert'}; - $invert =~ s/0/straight/; # 0=(false) = not inverted - $invert =~ s/1/inverted/; # 1=(true) - $input .= " $invert"; - if( $profile eq "cover"){ - my $ii = int($i/2); - $in_mode = $jhash->{"$profile:$ii"}{'in_mode'}; # cover: single, dual, detached - $in_swap = $jhash->{"cover:$ii"}{'swap_inputs'}; - $in_swap =~ s/0/normal/; # 0=(false) = not swapped - $in_swap =~ s/1/swapped/; # 1=(true) - $input .= " $in_mode $in_swap"; - }elsif( $model ne "shellyi4" ){ - $in_mode = $jhash->{"$profile:$i"}{'in_mode'}; # switch: follow, detached - $input .= " $in_mode" if( defined($in_mode) ); + if( !$profile ){ + foreach my $c ("switch","cover","light"){ + if( defined($jhash->{"$c:0"}{id}) ){ + $profile = $c; + last; + } + } + } + + my $c=0; # component counter + my $i=0; # input + my ($subs,$in_mode); + while( defined($profile) && defined($jhash->{"$profile:$c"}{id}) ){ # parse all components + $in_mode = $jhash->{"$profile:$c"}{in_mode}; + if( $profile eq "cover" || $profile eq "light" ){ + $i=2*$c; # two inputs each light-channel + # inputs mode: dimup-down with input_0 or dual dim + if( $in_mode eq "dual_dim" ){ + Shelly_readingsBulkUpdate($hash,"input_$i\_function","dimdown"); + $i++; + Shelly_readingsBulkUpdate($hash,"input_$i\_function","dimup"); + }elsif( $in_mode eq "dual" ){ + # inputs swapped (cover only, in dual mode) ? + my $in_swap = $jhash->{"cover:$c"}{swap_inputs}; + my $dir = ($in_swap==1?"down":"up")."wards"; + Shelly_readingsBulkUpdate($hash,"input_$i\_function",$dir); + $i++; + $dir = ($in_swap == 1?"up":"down")."wards"; + Shelly_readingsBulkUpdate($hash,"input_$i\_function",$dir); + $in_swap =~ s/0/normal/; # 0=(false) = not swapped + $in_swap =~ s/1/swapped/; # 1=(true) + }else{ + Shelly_readingsBulkUpdate($hash,"input_$i\_function",$in_mode); # Button set to "dim", "activate" or "detached" + # Switch as Toggle: 'follow' or Switch as Edge: 'flip' + $i++; + Shelly_readingsBulkUpdate($hash,"input_$i\_function","detached"); + } + }elsif( $model ne "shellyi4" ){ # switch: follow, detached + Shelly_readingsBulkUpdate($hash,"input_$i\_function",$in_mode); + } + # outputs swapped / reverse directions (cover only) ? + if( $profile eq "cover" ){ + my $output_swapped = $jhash->{"$profile:$c"}{invert_directions}; + $subs = $shelly_models{$model}[1]==1?"":"_$i"; + if( $output_swapped == 1 ){ + Shelly_readingsBulkUpdate($hash,"output$subs\_mode","O1=down, O2=up (swapped)"); + }else{ + Shelly_readingsBulkUpdate($hash,"output$subs\_mode","O1=up, O2=down"); + } + } + $c++; + } + # Y175 + my ($i_start,$input,$enable,$invert); + foreach $i_start (0, 100 ){ # eg ShellyPlusUni has input:100 as analog input + $i=$i_start; + while( defined($jhash->{"input:$i"}{id}) ){ # parse all inputs + if( $i < 100 ){ + $subs = $shelly_models{$model}[5]==1?"":"_$i"; + }else{ + $subs = $i - 100 + $shelly_models{$model}[5]; + $subs = "_$subs"; + } + + # type of input: button, switch, count, analog + $input = $jhash->{"input:$i"}{type}; + + # input inverted? + if( $input !~ /count/ ){ + $invert = $jhash->{"input:$i"}{invert}; + $invert =~ s/0/ straight /; # 0=(false) = not inverted + $invert =~ s/1/ inverted /; # 1=(true) + $input .= $invert; + } + + # input enabled? + $enable = $jhash->{"input:$i"}{enable}; + if( defined($enable) ){ + $enable =~ s/0/disabled /; # 0=(false) + $enable =~ s/1/enabled /; # 1=(true) + $input .= $enable; + }else{ + $input .= "-"; + } + + Log3 $name,5,"[Shelly_settings2G:config] $name has input $i: $input"; + readingsBulkUpdateMonitored($hash,"input$subs\_mode",$input) if( $input ); + readingsBulkUpdateMonitored($hash,"input$subs\_name",$jhash->{"input:$i"}{name}) if( $jhash->{"input:$i"}{name} ); + $i++; } - #$input = "$in_type $invert $in_mode $in_swap"; - $input .= " disabled" if( $jhash->{"input:$i"}{'enable'} && ($jhash->{"input:$i"}{'enable'})==0 ); - Log3 $name,5,"[Shelly_proc2G:config] $name has input $i: $input"; - readingsBulkUpdateMonitored($hash,"input$subs\_mode",$input) if( $input ); - readingsBulkUpdateMonitored($hash,"input$subs\_name",$jhash->{"input:$i"}{'name'}) if( $jhash->{"input:$i"}{'name'} ); - $i++; } } - # look if an addon is present: - if( $jhash->{'sys'}{'device'}{'addon_type'} ){ - readingsBulkUpdateMonitored($hash,"addon",$jhash->{'sys'}{'device'}{'addon_type'} ); + + ### auto_on & auto_off +if($shelly_models{$model}[2]>0){ + my ($chn,$c,$i,$val,$onoff); + $chn = $shelly_models{$model}[2]; + #$chn = 1 if( AttrVal($name,"mode", "color") eq "color" ); + for( $c=0;$c<$chn;$c++ ){ + $subs = ($chn>1 ? "_$c" : "" ); + # transition -- transition time (in seconds) + $val = $jhash->{"light:$c"}{transition_duration}; # 0 .... 5 sec, steps of 0.1 sec + if( defined($val) ){ + Shelly_readingsBulkUpdate($hash,"transition$subs",$val.$si_units{time}[$hash->{units}]); + } + # auto_on, auto_off -- default timer in seconds + foreach $onoff ("on","off"){ + $val=$jhash->{"light:$c"}{"auto_$onoff"}; + if( $val ){ + $val=$jhash->{"light:$c"}{"auto_$onoff\_delay"}; + $val.=$si_units{time}[$hash->{units}]; + }else{ + $val = "disabled"; + } + Shelly_readingsBulkUpdate($hash,"auto_$onoff$subs",$val); + } + } +} + + ### look if an addon is present: + if( $jhash->{sys}{device}{addon_type} ){ + readingsBulkUpdateMonitored($hash,"addon",$jhash->{sys}{device}{addon_type} ); }elsif(ReadingsVal($name,"addon",undef)){ fhem("deletereading $name addon"); } + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetDeviceInfo",undef,"Shelly_settings2G","info" ); + + ################ Shelly.GetDeviceInfo + }elsif($comp eq "info"){ + Log3 $name,4,"[Shelly_settings2G:info] $name: processing the answer from the \"/rpc/Shelly.GetDeviceInfo\" call"; + + $hash->{SHELLYID}=$jhash->{id}; + my $model_id = $jhash->{model}; # vendor id + readingsBulkUpdateIfChanged($hash,"model_ID",$model_id); - ################ Shelly.GetDeviceInfo - }elsif($comp eq "info"){ - Log3 $name,4,"[Shelly_proc2G:info] $name: processing the answer rpc/Shelly.GetDeviceInfo from Shelly_shelly()"; - - $hash->{SHELLYID}=$jhash->{'id'}; #my $firmware_ver = $jhash->{'fw_id'}; - my $fw_shelly = $jhash->{'ver'}; # the firmware information stored in the Shelly + my $fw_shelly = $jhash->{ver}; # the firmware information stored in the Shelly my $fw_fhem = ReadingsVal($name,"firmware","none"); # the firmware information that fhem knows - $fw_fhem =~ /v([^\(]*)\K(.*)/; - $fw_fhem = $1; - if( $fw_fhem eq $fw_shelly ){ - Log3 $name,4,"[Shelly_proc2G:info] $name: info about current firmware Shelly and Fhem are matching: $fw_shelly"; + $fw_fhem =~ /v([^\(]*)\K(.*)/; + $fw_fhem = $1; + if( $fw_fhem eq $fw_shelly ){ + Log3 $name,4,"[Shelly_settings2G:info] $name: info about current firmware Shelly and Fhem are matching: $fw_shelly"; }else{ - Log3 $name,4,"[Shelly_proc2G:info] $name: new firmware information read from Shelly: $fw_shelly"; + Log3 $name,4,"[Shelly_settings2G:info] $name: new firmware information read from Shelly: $fw_shelly"; readingsBulkUpdateIfChanged($hash,"firmware","v$fw_shelly"); - } - if( defined($jhash->{'name'}) ){##&& AttrVal($name,"ShellyName","") ne $jhash->{'name'}) { #ShellyName - readingsBulkUpdateIfChanged($hash,"name",$jhash->{'name'} ); - # $attr{$hash->{NAME}}{ShellyName} = $jhash->{'name'}; - }else{ - # if Shelly is not named, set name of Shelly equal to name of Fhem-device - ##fhem("set $name name " . $name ); - # $attr{$hash->{NAME}}{ShellyName} = $name; #set ShellyName as attribute } - ################ /settings - }elsif($comp eq "settings"){ - Log3 $name,4,"[Shelly_proc2G:settings] $name: processing the answer /settings from Shelly_shelly()";#4 - readingsBulkUpdateIfChanged($hash,"coiot",defined($jhash->{'coiot'}{'enabled'})?"enabled":"disabled"); - readingsBulkUpdateIfChanged($hash,"coiot_period", - defined($jhash->{'coiot'}{'update_period'})?$jhash->{'coiot'}{'update_period'}.$si_units{time}[$hash->{units}]:"disabled"); - readingsBulkUpdateIfChanged($hash,"network_threshold",$jhash->{'ap_roaming'}{'threshold'}.$si_units{rssi}[$hash->{units}]) - if( defined($jhash->{'ap_roaming'}{'threshold'}) ); - - readingsBulkUpdateIfChanged($hash,"name",$jhash->{'name'} ) if( defined($jhash->{'name'}) ); # ShellyName - } - ############################################################################################################################# - #-- common to roller and relay, also ShellyPMmini energymeter - if($comp eq "roller" || $comp eq "relay" || $comp eq "pm1" ){ - my $id = $jhash->{'id'}; - $subs = ( $mode eq "roller" ? $shelly_models{$model}[1] : $shelly_models{$model}[3])==1?"":"_$id"; - Log3 $name,4,"[Shelly_proc2G] $name: Processing metering channel$subs"; - if( $meters > 0 ){ - #checking for errors (if present) - $errors = $jhash->{'errors'}[0]; - $errors = "none" - if(!$errors); - #readingsBulkUpdateMonitored($hash,"errors".$subs,$errors); - - $voltage = $jhash->{'voltage'}.$si_units{voltage}[$hash->{units}]; - $current = $jhash->{'current'}.$si_units{current}[$hash->{units}]; - $power = $jhash->{'apower'} .$si_units{power}[$hash->{units}]; # active power + if( defined($jhash->{name}) ){ + readingsBulkUpdateIfChanged($hash,"name",$jhash->{name} ); + } + if( ReadingsVal($name,"addon","none") eq "sensor" ){ + Shelly_HttpRequest($hash,"/rpc/SensorAddon.GetPeripherals",undef,"Shelly_procAddOn"); + } + $hash->{helper}{settings_time}=time(); - $energy = $jhash->{'aenergy'}{'total'}; - # Energy consumption by minute (in Milliwatt-hours) for the last minute - $minutes = shelly_energy_fmt($hash,$jhash->{'aenergy'}{'by_minute'}[0],"mWh"); # is cumulated while minute restarts - - Log3 $name,4,"[Shelly_proc2G] $name $comp voltage$subs=$voltage, current$subs=$current, power$subs=$power"; #4 + $range_extender_enable = ReadingsVal($name,"ap_clients","disabled"); + if( $range_extender_enable ne "disabled" ){ + Shelly_HttpRequest( $hash,"/rpc/Wifi.ListAPClients",undef,"Shelly_settings2G","clients" ); + }elsif( $model !~ /display/ ){ + Shelly_HttpRequest( $hash,"/rpc/BLE.CloudRelay.List",undef,"Shelly_settings2G","BLEclients" ); + } + + ################ Wifi.ListAPClients + }elsif($comp eq "clients"){ + Log3 $name,4,"[Shelly_settings2G:clients] $name: processing the answer /rpc/Wifi.ListAPClients"; + fhem("deletereading $name ap_clients.*",1); # always clear readings before re-writing / silent + # this call return for each client: MAC, IP-address (as client), port and timestamp + my $xi=0; # ap-client index + my ($timestamp,$mac); + my $ip_ext; # ip at the extended network (ap of the Shelly), typical 192.168.33.nn + my $ip_int; # ip of the internal network, typical : + my $client_name; # the fhem NAME of the client + my $client; # the fhem internal 'NAME' of the client - readingsBulkUpdateMonitored($hash,"voltage".$subs,$voltage); - readingsBulkUpdateMonitored($hash,"current".$subs,$current); - readingsBulkUpdateMonitored($hash,"power" .$subs,$power); - # PowerFactor not supported by ShellyPlusPlugS, ShellyPMmini and others - readingsBulkUpdateMonitored($hash,"pfactor".$subs,$jhash->{'pf'}) if( defined($jhash->{'pf'}) ); - - # frequency supported from fw 1.0.0 - readingsBulkUpdateMonitored($hash,"frequency".$subs,$jhash->{'freq'}.$si_units{frequency}[$hash->{units}]) - if( defined($jhash->{'freq'}) ); - - readingsBulkUpdateMonitored($hash,"energy" .$subs,shelly_energy_fmt($hash,$energy,"Wh")); - #readingsBulkUpdateMonitored($hash,"energy_lastMinute".$subs,$minutes); - readingsBulkUpdateMonitored($hash,"protection".$subs,$errors); - readingsBulkUpdateMonitored($hash,"state",$power) if($model eq "shellypmmini"); - - } - # temperature not provided by all devices - if( defined($jhash->{'temperature'}{'tC'}) ){ - readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'temperature'}{'tC'}.$si_units{tempC}[$hash->{units}]); - }elsif( defined($jhash->{'temperature:0'}{'tC'}) ){ - readingsBulkUpdateMonitored($hash,"inttemp",$jhash->{'temperature:0'}{'tC'}.$si_units{tempC}[$hash->{units}]); + while( $jhash->{ap_clients}[$xi]{mac} ){ + + # use the since-value as Readings-Timestamp + $timestamp = FmtDateTime($jhash->{ap_clients}[$xi]{since}); + + # MAC + $mac = uc($jhash->{ap_clients}[$xi]{mac}); # uppercase of clients MAC + Shelly_readingsBulkUpdate($hash,"ap_clients_$xi\_mac",$mac,undef,$timestamp ); + + # the ip at the extended network + $ip_ext = $jhash->{ap_clients}[$xi]{ip}; + Shelly_readingsBulkUpdate($hash,"ap_clients_$xi\_extlink",$ip_ext,undef,$timestamp ); + + # intlink + $ip_int = InternalVal($name,"DEF","ip"); + $ip_int.= ":".$jhash->{ap_clients}[$xi]{mport}; + Shelly_readingsBulkUpdate($hash,"ap_clients_$xi\_intlink",$ip_int,undef,$timestamp ); + + # scanning all fhem-devices for the internal 'MAC' + $client_name = (defInfo("MAC=$mac",'NAME'))[0]; # returns undef if no device with a matching MAC found + if( $client_name ){ + Log3 $name,3,"[Shelly_settings2G:APclients] $name: found client \'$client_name\' with MAC=$mac"; + Shelly_readingsBulkUpdate($hash,"ap_clients_$xi\_model",ReadingsVal($client_name,"model_name","unknown"),undef,$timestamp ); + $client = InternalVal($client_name,"DEF",undef); + if( $client ne $ip_int ) { + Log3 $name,1,"[Shelly_settings2G:APclients] $client_name: wrong definition \'$client\', use :"; + $client = "clients \'$client_name\' definition \'$client\' is wrong"; + }else{ + Log3 $name,3,"[Shelly_settings2G:APclients] device \'$client_name\' is defined as $client (OK)"; + # format as clickable link + $client = "$client_name"; + } + }else{ + $client = "no definition"; # may be a smartphone as client - this is no error + Log3 $name,3,"[Shelly_settings2G:APclients] $name: no fhem device found with MAC=$mac "; + } + Shelly_readingsBulkUpdate($hash,"ap_clients_$xi\_name",$client,undef,$timestamp ); + $xi++; } - # processing timers - if( $jhash->{'timer_started_at'} ){ - if( $jhash->{'timer_remaining'} ){ - $timer = $jhash->{'timer_remaining'}; - }else{ - $timer = $jhash->{'timer_started_at'} + $jhash->{'timer_duration'} - time(); - $timer = round($timer,1); - } - readingsBulkUpdateMonitored($hash,"timer".$subs,$timer.$si_units{time}[$hash->{units}]); - }elsif(ReadingsVal($name,"timer$subs",undef) ){ - readingsBulkUpdateMonitored($hash,"timer".$subs,'-'); + Shelly_readingsBulkUpdate($hash,"ap_clients",$xi,undef,FmtDateTime($jhash->{ts}) ); # Total number of clients + ###--- start next request + if( $model !~ /display/ ){ + Shelly_HttpRequest( $hash,"/rpc/BLE.CloudRelay.List",undef,"Shelly_settings2G","BLEclients" ); } - #--- - #calculate all periods - my @TPs=split(/,/x, AttrVal($name,"Periods", "") ); - #$unixtime = $unixtime-$unixtime%60; # adjust to lass full minute - my $unixtime = time(); - #$TimeStamp = FmtDateTime($unixtime-$unixtime%60); # adjust to lass full minute - my $TimeStamp = FmtDateTime( time() ); - foreach my $TP (@TPs) - { - Log3 $name,5,"[Shelly__proc2G:status] $name: calling shelly_delta_energy for period \'$TP\' "; - shelly_delta_energy($hash,"energy_",$TP,$unixtime,$energy,$TimeStamp,fhem('{$isdst}')); + + ################ BLE.CloudRelay.List + }elsif($comp eq "BLEclients"){ + Log3 $name,4,"[Shelly_settings2G:BLEclients] $name: processing the answer /rpc/BLE.CloudRelay.List"; + my $ai=0; + + # /rpc/BLE.CloudRelay.List + while( defined($jhash->{addrs}[$ai]) ){ + readingsBulkUpdateIfChanged($hash,"ble_client_$ai",$jhash->{addrs}[$ai] ); + $ai++; + } + while( defined(ReadingsVal($name,"ble_client_$ai",undef)) ){ + fhem("deletereading $name ble_client_$ai"); # not silent: -> logging at level 3 + $ai++; + } + Shelly_HttpRequest( $hash,"/rpc/Webhook.List",undef,"Shelly_settings2G","actions",1 ); #call silent + + + ################ Webhook.List + }elsif($comp eq "actions"){ + Log3 $name,4,"[Shelly_settings2G:actions] $name: processing the answer /rpc/Webhook.List"; + my $silent = defined($param->{val})?1:0;#Debug "silent $name=$silent="; + my ($e,$i,$u,$id,$event,$action,$isenabled,$rev); + my $count=0; + my $enabled=0; + my $unused=0; + my $msg="IdNameActionURLEN/DIS"; + my $url; + $rev = $jhash->{rev}; + # foreach my $m ($model,"addon1"){ + # for( $e=0; $event = $shelly_events{$m}[$e] ; $e++ ){ + for( $i=0; defined($jhash->{hooks}[$i]{id}) ;$i++ ){ + $id = $jhash->{hooks}[$i]{id}; + $event = $jhash->{hooks}[$i]{event}; + $action= $jhash->{hooks}[$i]{name}; + for( $u=0; $u<5 ; $u++ ){ + $url=$jhash->{hooks}[$i]{urls}[$u]; + if( defined($url) ){ + $msg.="$id  $action  $event  $url  "; + $count++; + $isenabled=$jhash->{hooks}[$i]{enable}; + $isenabled =~ s/0|(false)/DIS/; + $isenabled =~ s/1|(true)/EN/; + $msg .= $isenabled; + $enabled++ if( $isenabled eq "EN" ); + $msg .=""; + }elsif( $u == 0 ){ + $unused++; + $msg.="$eventno URL defined"; + } + } + } + #} + #} + $msg .= " Rev=$rev  unused actions=$unused "; + $msg .= "Total URLs=$count  Enabled=$enabled"; + $msg =~ s/%20/ /g; + $msg = "$msg
"; + $msg ="No Actions" if( $count == 0 ); + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"$msg\" )", "") if( $silent == 0 ); + readingsBulkUpdateIfChanged($hash,"webhook_cnt",$enabled ); + readingsBulkUpdateIfChanged($hash,"webhook_ver",$rev ); + + ################ Webhook.Update + }elsif($comp eq "webhook_update"){ + Log3 $name,4,"[Shelly_settings2G:webhook_update] $name: processing the answer /rpc/Webhook.Update"; + my $rev = $jhash->{rev}; + if( !defined($rev) ){ + readingsBulkUpdateIfChanged($hash,"error","action not changed" ); + }else{ + readingsBulkUpdateIfChanged($hash,"webhook_ver",$rev ); + } + } + #----------------------------------------------------------------------------------------- + readingsEndUpdate($hash,1); +} # END Shelly_settings2G() + + +######################################################################################## +# +# Shelly_procAddOn - process config/settings of 2nd generation sensor add-on +# +######################################################################################## + +sub Shelly_procAddOn { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my ($peripheralT,$comp_type,$comp_id,$addr,$subs,$name); + readingsBeginUpdate($hash); + #--------------------------------------- + if( $param->{cmd} eq "/rpc/SensorAddon.GetPeripherals" ){ + foreach $peripheralT ("digital_in", "ds18b20", "dht22", "analog_in", "voltmeter" ){ + $comp_type = $peripherals{$peripheralT}; + if( $jhash->{$peripheralT} ){ + foreach $comp_id ( 100..110 ){ + next if( !defined($jhash->{$peripheralT}{"$comp_type:$comp_id"}{addr}) ); + $addr = $jhash->{$peripheralT}{"$comp_type:$comp_id"}{addr}; + $addr =~ m/(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?)/; + $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X",$1,$2,$3,$4,$5,$6,$7,$8); + $subs = "_".($comp_id-100); + readingsBulkUpdateMonitored($hash,"$comp_type$subs\_sensor","$comp_id $peripheralT $addr" ); + } + } + } + #--------------------------------------- + }elsif( $param->{cmd} eq "/rpc/SensorAddon.OneWireScan" ){ + my $dev_id=0; + my $type; + while( $jhash->{devices}[$dev_id]{type} ){ + $type = $jhash->{devices}[$dev_id]{type}; + $addr = $jhash->{devices}[$dev_id]{addr}; + $addr =~ m/(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?):(\d\d?\d?)/; + $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X",$1,$2,$3,$4,$5,$6,$7,$8); + # if a device is not already registered by the shelly, component is null + if( defined($jhash->{devices}[$dev_id]{component}) ){ + $comp_id = $jhash->{devices}[$dev_id]{component}; + $comp_id =~ m/temperature:(\d*)/; + $comp_id = $1; + $subs = "_".($comp_id-100); + readingsBulkUpdateMonitored($hash,"temperature$subs\_sensor","$comp_id:$dev_id $type $addr" ); + }else{ + $addr = $jhash->{devices}[$dev_id]{addr}; # reload w/decimal values + my $cmd = "?type=\"$type\"&attrs={\"addr\":\"$addr\"}"; + #$cmd = urlEncode($cmd); + #$cmd = urlDecode($cmd); + Shelly_HttpRequest("Y175","/rpc/SensorAddon.AddPeripheral",$cmd); + } + $dev_id++; + } + #--------------------------------------- + }elsif( $param->{cmd} eq "/rpc/SensorAddon.AddPeripheral" ){ + my $count=0; + foreach $comp_id ( 100..110 ){ + if( defined($jhash->{"temperature:$comp_id"}) ){ + $count++; + } + } + Shelly_Set($hash,$name,"reboot"); + #--------------------------------------- + }elsif( $param->{cmd} eq "/rpc/Temperature.GetConfig" ){ + $comp_type="temperature"; + if( defined($jhash->{id}) ){ + $comp_id = $jhash->{id}; + if( defined($jhash->{name}) ){ + $name = $jhash->{name}; + $subs = "_".($comp_id-100); + readingsBulkUpdateMonitored($hash,"$comp_type$subs\_name",$name ); + } + $comp_id++; + } + return if( $comp_id > 110 ); + Shelly_HttpRequest("Y175","/rpc/Temperature.GetConfig","?id=$comp_id"); + #--------------------------------------- + }elsif( $param->{cmd} eq "/rpc/Shelly.GetConfig" ){ + my ($jelement,$jvalue,$jreading); + # sys device + foreach $jelement ("name","mac","fw_id","profile","addon_type" ){ + $jvalue = $jhash->{sys}{device}{$jelement}; + $jvalue = "-" unless defined($jvalue); + $jreading = "sys_device_$jelement"; + readingsBulkUpdateMonitored($hash,$jreading,$jvalue); + } + # wifi + foreach $jelement ("ap","sta","sta1" ){ + $jvalue = $jhash->{wifi}{$jelement}{ssid}; + $jvalue = "-" unless defined($jvalue); + $jreading = "wifi_$jelement\_ssid"; + readingsBulkUpdateMonitored($hash,$jreading,$jvalue); + } + foreach $jelement ("rssi_thr","interval" ){ + $jvalue = $jhash->{wifi}{roam}{$jelement}; + $jvalue = "-" unless defined($jvalue); + $jreading = "wifi_roam_$jelement"; + $jreading =~ s/{/_/g; + $jreading =~ s/}//g; + + readingsBulkUpdateMonitored($hash,$jreading,$jvalue); } - #--- } + #--------------------------------------- readingsEndUpdate($hash,1); - - if($comp eq "status" || $comp eq "config" || $comp eq "info"){ - return -1; - }else{ - return $timer; - } - } +} # END Shelly_procAddOn - - ######################################################################################## # -# Shelly_EMData - process EM Energy Data +# Shelly_procEMvalues - processing ShellyPro3EM (channel=0) Energy Metering values +# data requested by /rpc/EM.GetStatus?id=0 # -# Parameter hash, ... +# Parameter param, jhash +# +# Readings: current, power (active, apparent, reactive), voltage, frequency, power factor # ######################################################################################## -sub Shelly_EMData { - my ($hash, $comp, $err, $data) = @_; - $hash->{units}=0 if( !defined($hash->{units}) ); - my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; - my $model = AttrVal($name,"model","generic"); - # check we have a second gen device - if( $shelly_models{$model}[4]==0 || $model ne "shellypro3em" ){ - return "$name ERROR: calling Proc2G for a not 2ndGen Device"; +sub Shelly_procEMvalues { + my ($param,$jhash) = @_; + my $hash=$param->{hash}; + my $name=$hash->{NAME}; + + Log3 $name,4,"[Shelly_procEMvalues] processing Shelly_procEMvalues() for device $name channel/id=".$jhash->{id}; #4 + + return if( AttrVal($name,"model","none") ne "shellypro3em" ); + + readingsBeginUpdate($hash); + + my $suffix = AttrVal($name,"EMchannels","_ABC"); + my ($pr,$ps,$reading,$value); + my ($act_power,$aprt_power); + my $reactivePower=0; # calculated reactive power + my $power=0; # cumulated active power + + foreach my $emch ( "a_","b_","c_","total_" ){ + if( $suffix eq "ABC_" || $suffix eq "L123_" ){ + $pr=$mapping{sf}{$suffix}{$emch}; + $ps=""; + }else{ + $pr=""; + $ps=$mapping{sf}{$suffix}{$emch}; + } #Debug "$emch-$pr-$ps curr:".$jhash->{$emch.'current'}; + $reading=$pr.$mapping{E1}{current}.$ps; + $value =sprintf("%5.3f%s",$jhash->{$emch.'current'},$si_units{current}[$hash->{units}]); + + readingsBulkUpdateMonitored($hash,$reading,$value); + + $reading=$pr.$mapping{E1}{aprt_power}.$ps; + $aprt_power=$jhash->{$emch.'aprt_power'}; + Debug "may be system error" if( !defined($aprt_power) ); + $value =sprintf("%4.1f%s",$aprt_power, $si_units{apparentpower}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,$reading,$value); + $reading=$pr.$mapping{E1}{act_power}.$ps; + $act_power=$jhash->{$emch.'act_power'}; + $value =sprintf("%5.1f%s",$act_power, $si_units{power}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,$reading,$value); # store this also as helper + + if($emch ne "total_"){ + # to get latest values when calculating total pushed value + $hash->{helper}{$emch.'Active_Power'}=$act_power; + + $reading=$pr.$mapping{E1}{voltage}.$ps; + $value =sprintf("%4.1f%s",$jhash->{$emch.'voltage'},$si_units{voltage}[$hash->{units}]); + readingsBulkUpdateMonitored($hash,$reading,$value); + + $reading=$pr.$mapping{E1}{pf}.$ps; + $value = $jhash->{$emch.'pf'}; + $value = sprintf("%4.2f%s",abs($value),( abs($value)==1?"":" (".( $value<0 ? $mapping{E1}{cap}:$mapping{E1}{ind}).")")); + readingsBulkUpdateMonitored($hash,$reading,$value); + + $reading=$pr.$mapping{E1}{frequency}.$ps; + $value = $jhash->{$emch.'freq'}; + readingsBulkUpdateMonitored($hash,$reading,$value.$si_units{frequency}[$hash->{units}]) if( defined($value) ); # supported from fw 1.0.0 + + $power += $act_power; + # reactive power: not provided by Shelly + if(1){ # calculation of reactive power! + $reading=$pr.$mapping{E1}{react_power}.$ps; + $value = ($aprt_power * $aprt_power) - ($act_power * $act_power); + $value = ($value<=>0)*sqrt( abs($value) ); + $reactivePower += $value; + $value = sprintf("%4.1f%s",$value, $si_units{reactivepower}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,$reading,$value); + } + }else{ + $reading=$pr.$mapping{E1}{react_power}.$ps; + $value = sprintf("%4.1f%s",$reactivePower, $si_units{reactivepower}[$hash->{units}] ); + readingsBulkUpdateMonitored($hash,$reading,$value); + } + } + $value = $jhash->{'n_current'}; + if( defined($value) ){ + $reading='Current_N'; ## $pr.$mapping{E1}{current}.$ps; + $value =sprintf("%5.3f%s",$value,$si_units{current}[$hash->{units}]); + readingsBulkUpdateMonitored($hash,$reading,$value); } - if( $hash && !$err && !$data ){ - if( $model eq "shellypro3em" ){ - $comp = "EMData"; - } - # my $url = "http://".Shelly_pwd($hash).$hash->{TCPIP}."/rpc/$comp.GetStatus?id=0"; - my $url = "http://".Shelly_pwd($hash).$hash->{TCPIP}."/rpc/Shelly.GetStatus"; # all data in one loop - Log3 $name,4,"[Shelly_EMData] issue a non-blocking call to $url"; - HttpUtils_NonblockingGet({ - url => $url, - timeout => AttrVal($name,"timeout",4), - callback => sub($$$){ Shelly_EMData($hash,$comp,$_[1],$_[2]) } - }); - return undef; - }else{ - #-- cyclic update nevertheless - RemoveInternalTimer($hash,"Shelly_EMData"); - # adjust timer to one second after full minute - my $Tupdate = int((time()+60)/60)*60+1; - Log3 $name,4,"[Shelly_EMData] $name: next EMData update at $Tupdate = ".strftime("%H:%M:%S",localtime($Tupdate) )." Timer is Shelly_EMdata"; - InternalTimer($Tupdate, "Shelly_EMData", $hash, 1) - if( $hash->{INTERVAL} != 0 ); - } + ### Balancing: cumulate power values and save them in helper, will be used by Shelly_procEMData() + $hash->{helper}{powerCnt}++; + $hash->{helper}{power} += $power; + $hash->{helper}{powerPos} += $power if($power>0); + $hash->{helper}{powerNeg} -= $power if($power<0); # the cumulated value is positive! - #-- error in non blocking call - if( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_EMData",$err); - return $err; - } + readingsBulkUpdateMonitored($hash,"state","OK"); - Log3 $name,5,"[Shelly_EMData] device $name has returned data $data"; - - # extracting json from data - readingsBeginUpdate($hash); - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - - #-- error in data - if( !$jhash ){ - Shelly_error_handling($hash,"Shelly_EMData","invalid JSON data"); - return; + readingsEndUpdate($hash,1); + #~~~~~~~~~~~~~~~~~~~~~ + if( $hash->{INTERVAL}>0 ){ + #-- initiate next run + my $timer=AttrVal($name,"interval_power",$hash->{INTERVAL}); + RemoveInternalTimer($hash,"Shelly_getEMvalues"); + InternalTimer(time()+$timer, "Shelly_getEMvalues", $hash); + Log3 $name,4,"[Shelly_procEMvalues] $name: next \'Get EM values\' update in $timer seconds"; #4 } - - my $channel = $jhash->{'id'}; - my $meters = $shelly_models{$model}[3]; - - my ($subs,$ison,$overpower,$voltage,$current,$power,$energy,$pfactor,$freq,$minutes,$errors); ##R minutes errors +} #END Shelly_procEMvalues() - ############retrieving EM data - if( $model eq "shellypro3em" ){ - - # Here we have some coding regarding the reading-names - my $suffix = AttrVal($name,"EMchannels","_ABC"); - my ($pr,$ps,$reading,$value,$errors); - my ($active_energy,$return_energy,$deltaEnergy,$deltaAge,$unixtime,$TimeStamp); - - $unixtime = $jhash->{'sys'}{'unixtime'}; - readingsBulkUpdateMonitored($hash,"timestamp",strftime("%Y-%m-%d %H:%M:%S",localtime($unixtime) ) ); - - # Energy Readings are calculated by the Shelly every minute, matching "zero"-seconds - # with some processing time the result will appear in fhem some seconds later - # we adjust the Timestamp to Shellies time of calculation and use a propretary version of the 'readingsBulkUpdateMonitored()' sub - $TimeStamp = FmtDateTime($unixtime-$unixtime%60); # adjust to lass full minute - #--- looping all phases - foreach my $emch ( "a_","b_","c_","total_" ){ - if( $suffix eq "ABC_" || $suffix eq "L123_" ){ + +######################################################################################## +# +# Shelly_procEMData - processing ShellyPro3EM (channel=0) Energy Data +# data requested by /rpc/EMData.GetStatus?id=0 +# +# Parameter param, jhash +# +######################################################################################## + +sub Shelly_procEMData { + my ($param,$jhash) = @_; + my $hash=$param->{hash}; + my $name=$hash->{NAME}; + + my $unixtime = time();####$jhash->{sys}{unixtime}; + my $TimeStamp = strftime("%Y-%m-%d %H:%M:%S",localtime($unixtime) ); + readingsBeginUpdate($hash); + #readingsBulkUpdateMonitored($hash,"timestamp", $TimeStamp); + Log3 $name,5,"[Shelly_procEMData] processing Shelly_procEMData() for device $name"; #5 + + # Energy Readings are calculated by the Shelly every minute, matching "zero"-seconds + # with some processing time the result will appear in fhem some seconds later + # we adjust the Timestamp to Shellies time of calculation and use a propretary version of the 'readingsBulkUpdateMonitored()' sub + $TimeStamp = FmtDateTime($unixtime-$unixtime%60); # adjust to lass full minute + + # Here we have some coding regarding the reading-names + my $suffix = AttrVal($name,"EMchannels","_ABC"); + my ($pr,$ps,$reading,$value); + my ($active_energy,$return_energy,$deltaEnergy,$deltaAge); + + #--- looping all phases + foreach my $emch ( "a_","b_","c_","total_" ){ + if( $suffix eq "ABC_" || $suffix eq "L123_" ){ $pr=$mapping{sf}{$suffix}{$emch}; $ps=""; - }else{ + }else{ $pr=""; $ps=$mapping{sf}{$suffix}{$emch}; - } - foreach my $flow ("act","act_ret"){ + } + foreach my $flow ("act","act_ret"){ if( $emch ne "total_" ){ $reading = $pr.$mapping{E1}{'total_'.$flow.'_energy'}.$ps; - $value = $jhash->{'emdata:0'}{$emch.'total_'.$flow.'_energy'}; + #$value = $jhash->{'emdata:0'}{$emch.'total_'.$flow.'_energy'}; + $value = $jhash->{$emch.'total_'.$flow.'_energy'}; }else{ # processing total_ values $reading = $pr.$mapping{E1}{$flow}.$ps; - $value = $jhash->{'emdata:0'}{'total_'.$flow}; + #$value = $jhash->{'emdata:0'}{'total_'.$flow}; + $value = $jhash->{'total_'.$flow}; if( $flow eq "act" ){ $active_energy = $value; }else{ @@ -3927,70 +5023,53 @@ sub Shelly_EMData { } $value = shelly_energy_fmt($hash,$value,"Wh"); Shelly_readingsBulkUpdate($hash,$reading,$value,undef,$TimeStamp); - } - # checking for errors - # may contain: power_meter_failure, no_load - if( defined($jhash->{'em:0'}{$emch.'errors'}[0]) ){ - #$errors = $jhash->{'em:0'}{$emch.'errors'}[0]; - #$errors .= "$pr$ps: $errors " if( defined($errors) ); - $errors .= "$pr$ps: ".$jhash->{'em:0'}{$emch.'errors'}[0]; - } } - # checking for EM-system errors - # may contain: power_meter_failure, phase_sequence, no_load - if( $jhash->{'em:0'}{'errors'}[0] ){ - $errors .= "System: ".$jhash->{'em:0'}{'errors'}[0]; - } - readingsBulkUpdateMonitored($hash,"errors",defined($errors)?$errors:"OK"); - - $value = $jhash->{'temperature:0'}{'tC'}.$si_units{tempC}[$hash->{units}]; - readingsBulkUpdateMonitored($hash,"inttemp",$value); + } - #initialize helper values to avoid error in first run - if( !defined( $hash->{helper}{timestamp_last} ) ){ + #initialize helper values to avoid error in first run + if( !defined( $hash->{helper}{timestamp_last} ) ){ $hash->{helper}{timestamp_last} = $unixtime - 60; $hash->{helper}{Total_Energy_S}=0; $hash->{helper}{powerPos} = 0; $hash->{helper}{powerNeg} = 0; - } - - ### processing calculated values ### - ### 1. calculate Total Energy + } + + ### processing calculated values ### + ### 1. calculate Total Energy $value = shelly_energy_fmt($hash,$active_energy - $return_energy,"Wh"); Shelly_readingsBulkUpdate($hash,"Total_Energy_S",$value,undef,$TimeStamp); - - ### 2. calculate a power value from the difference of Energy measures + + ### 2. calculate a power value from the difference of Energy measures $deltaAge = $unixtime - $hash->{helper}{timestamp_last}; $hash->{helper}{timestamp_last} = $unixtime; - + $deltaEnergy = $active_energy - $return_energy - $hash->{helper}{Total_Energy_S}; $hash->{helper}{Total_Energy_S} =$active_energy-$return_energy; - + $reading = $pr.$mapping{E1}{"act_calculated"}; # Active_Power_calculated $value = sprintf("%4.1f",3600*$deltaEnergy/$deltaAge) if( $deltaAge>0 ); # this is a Power value in Watts. - $value .= $si_units{power}[$hash->{units}]; + $value .= $si_units{power}[$hash->{units}]; $value .= sprintf(" \( %d Ws = %5.2f Wh in %d s \)",3600*$deltaEnergy,$deltaEnergy,$deltaAge); Shelly_readingsBulkUpdate($hash,$reading,$value,undef,$TimeStamp); - ### 3. calculate Energy-differences for a set of different periods + ### 3. calculate Energy-differences for a set of different periods #prepare the list of periods my @TPs=split(/,/x, AttrVal($name,"Periods", "") ); - + #calculate all periods - my $dst = fhem('{$isdst}'); # is daylight saving time (Sommerzeit) ? gets a log entry {$isdst} at level 3 + my $dst = fhem('{$isdst}',1); # is daylight saving time (Sommerzeit) ? silent/no log entry {$isdst} at level 3 $unixtime = $unixtime-$unixtime%60; # adjust to lass full minute foreach my $TP (@TPs){ - Log3 $name,5,"[Shelly__proc2G:status] calling shelly_delta_energy for period \'$TP\' "; + Log3 $name,5,"[Shelly_procEMData] calling shelly_delta_energy for period \'$TP\' "; # Shellie'S Energy value 'S' shelly_delta_energy($hash,"Total_Energy_S_", $TP,$unixtime,$active_energy-$return_energy,$TimeStamp,$dst); shelly_delta_energy($hash,"Purchased_Energy_S_",$TP,$unixtime,$active_energy,$TimeStamp,$dst); shelly_delta_energy($hash,"Returned_Energy_S_", $TP,$unixtime,$return_energy,$TimeStamp,$dst); } - - - if( AttrVal($name,"Balancing",1) == 1 && $hash->{helper}{powerCnt} ){ # don't divide by zero - + ############ Balancing ###################### + if( AttrVal($name,"Balancing",1) == 1 && $hash->{helper}{powerCnt} ){ # don't divide by zero + Log3 $name,5,"[Shelly_procEMData] processing Balancing"; ### 4. calculate a power value by integration of single power values ### calculate purchased and returned Energy out of integration of positive and negative power values my ($mypower,$mypowerPos,$mypowerNeg)=(0,0,0); @@ -3999,7 +5078,7 @@ sub Shelly_EMData { $si_units{power}[$hash->{units}],$hash->{helper}{powerCnt} ); $mypowerPos = $hash->{helper}{powerPos} / $hash->{helper}{powerCnt}; $mypowerNeg = $hash->{helper}{powerNeg} / $hash->{helper}{powerCnt}; - + $hash->{helper}{Energymeter_P}=1000*ReadingsNum($name,"Purchased_Energy_T",ReadingsNum($name,"Purchased_Energy_S",0)) unless( $hash->{helper}{Energymeter_P} ); #$active_energy; $hash->{helper}{Energymeter_R}=1000*ReadingsNum($name,"Returned_Energy_T", ReadingsNum($name,"Returned_Energy_S", 0)) @@ -4007,7 +5086,7 @@ sub Shelly_EMData { $active_energy_i = $mypowerPos/60 + $hash->{helper}{Energymeter_P}; # Energy in Watthours $return_energy_i = $mypowerNeg/60 + $hash->{helper}{Energymeter_R}; - Log3 $name,6,"[a] integrated Energy= $active_energy_i $return_energy_i in Watthours"; + Log3 $name,5,"[Shelly_procEMData] integrated Energy= $active_energy_i $return_energy_i in Watthours"; $mypowerPos = sprintf("%4.1f %s (%d Ws = %5.2f Wh)", $mypowerPos,$si_units{power}[$hash->{units}],$mypowerPos*60,$mypowerPos/60 ); $mypowerNeg = sprintf("%4.1f %s (%d Ws = %5.2f Wh)", $mypowerNeg,$si_units{power}[$hash->{units}],$mypowerNeg*60,$mypowerNeg/60); # don't write out when not calculated @@ -4015,18 +5094,18 @@ sub Shelly_EMData { readingsBulkUpdateMonitored($hash,$pr.$mapping{E1}{act_integratedPos},$mypowerPos); readingsBulkUpdateMonitored($hash,$pr.$mapping{E1}{act_integratedNeg},$mypowerNeg); - # 5. reset helper values. They will be set while cyclic update of power values. A small update interval is necessary! + ### 5. reset helper values. They will be set while cyclic update of power values. A small update interval is necessary! $hash->{helper}{power} = 0; $hash->{helper}{powerPos} = 0; $hash->{helper}{powerNeg} = 0; - $hash->{helper}{powerCnt} = 0; - + $hash->{helper}{powerCnt} = 0; + ### 6. safe these values for later use, independent of readings format, in Wh. # We need them also to adjust the offset-attribute, see Shelly_attr(): $hash->{helper}{Energymeter_P}=$active_energy_i; $hash->{helper}{Energymeter_R}=$return_energy_i; - - # 7. calculate the suppliers meter value + + ### 7. calculate the suppliers meter value foreach my $EM ( "F","P","R" ){ if( defined(AttrVal($name,"Energymeter_$EM",undef)) ){ $reading = "Total_Energymeter_$EM"; @@ -4042,8 +5121,8 @@ sub Shelly_EMData { $value = shelly_energy_fmt($hash, $value,"Wh"); Shelly_readingsBulkUpdate($hash,"Total_Energymeter_$EM", $value, undef, $TimeStamp); } - } - + } + ### 8. write out actual balanced meter values readingsBulkUpdateMonitored($hash,"Purchased_Energy_T",shelly_energy_fmt($hash,$active_energy_i,"Wh"), undef, $TimeStamp); readingsBulkUpdateMonitored($hash,"Returned_Energy_T", shelly_energy_fmt($hash,$return_energy_i,"Wh"), undef, $TimeStamp); @@ -4055,76 +5134,75 @@ sub Shelly_EMData { shelly_delta_energy($hash,"Total_Energy_T_", $TP,$unixtime,$active_energy_i-$return_energy_i,$TimeStamp,$dst); # $return_energy is positive shelly_delta_energy($hash,"Purchased_Energy_T_",$TP,$unixtime,$active_energy_i,$TimeStamp,$dst); shelly_delta_energy($hash,"Returned_Energy_T_", $TP,$unixtime,$return_energy_i,$TimeStamp,$dst); - } - } - } - readingsEndUpdate($hash,1); - return undef; -} - + } + } # Balancing/ + readingsEndUpdate($hash,1); + + if( $hash->{INTERVAL}>0 ){ + #-- initiate next run, adjusted to full minute plus 1 sec, but not less than interval + my $timer = int(($hash->{INTERVAL}-1)/60) + 1; # in minutes + Log3 $name,4,"[Shelly_procEMData] $name: next \'EM Data\' update in $timer minutes"; #4 + RemoveInternalTimer($hash,"Shelly_getEMData"); + InternalTimer( (int(time()/60)+$timer)*60+1, "Shelly_getEMData", $hash); + } + return undef; +} #END Shelly_procEMData() + + ######################################################################################## # -# shelly_delta_energy - calculate energy for a periode +# shelly_delta_energy - calculate energy for a periode # -# Parameter hash, +# Parameter hash, # reading name of the reading of the energy-counter # TP time periode like 'hourQ' -# unixtime epochtime, read from the shelly, adjusted to the last full minute +# utime epochtime, adjusted to the last full minute # energy value of the energy-counter, in Watt-hours (Wh) # TimeStamp timestamp adjusted to the last full minute # dst daylight savings time # ######################################################################################## + sub shelly_delta_energy { - my ($hash,$reading,$TP,$unixtime,$energy,$TimeStamp,$dst) = @_;#Debug "$unixtime,$energy,$TimeStamp"; - + my ($hash,$reading,$TP,$utime,$energy,$TimeStamp,$dst) = @_; + my ($energyOld,$denergy,$timestampRef,$dtime); - + return if(!$periods{$TP}[2]); #avoid illegal modulus - $reading .= $TP; - #$timestampRef=time_str2num(ReadingsTimestamp($hash->{NAME},$reading,"2023-07-01 00:00:00")); - $timestampRef=ReadingsTimestamp($hash->{NAME},$reading, - "2023-12-05 16-00-00" #ReadingsTimestamp($hash->{NAME},"energy",undef) - ); + $reading .= $TP; + $timestampRef=ReadingsTimestamp($hash->{NAME},$reading,"2023-12-05 16-00-00" ); if( $timestampRef ){ $timestampRef=time_str2num( $timestampRef ); #convert to epoch-time, like str2time - $dtime = $unixtime - $timestampRef; + $dtime = $utime - $timestampRef; }else{ $dtime = 0; } - # $timestampRef = $timestampRef + $periods{$TP}[2] - ($timestampRef+$periods{$TP}[$dst]) % $periods{$TP}[2]; #adjust to last full minute,hour,etc. - # if( $unixtime >= $timestampRef ){ if( $dtime >= $periods{$TP}[2] - ($timestampRef+$periods{$TP}[$dst]) % $periods{$TP}[2] ){ - - $energyOld=ReadingsVal($hash->{NAME},$reading,undef); - if( $energyOld ){ - $energyOld=~ /.*\((.*)\).*/;#Debug ": $reading - $energyOld - $energy - $1 -"; #$hash->{NAME}. - $denergy = $energy - $1; # energy used in this periode - $denergy = 0 if( $denergy < 0 ); - }else{ - $denergy = 0; # if(abs($denergy) < 0.001); - } - - my $power = $dtime ? sprintf(" %4.1f %s",3600*$denergy/$dtime,$si_units{power}[$hash->{units}]) : "-"; - readingsBulkUpdate($hash,$reading, - shelly_energy_fmt($hash,$denergy,"Wh") - .sprintf(" (%7.4f) ",$energy) - .$power, - undef, $TimeStamp); - #--- corrected values ? - my $corrFactor = AttrVal($hash->{NAME},"PeriodsCorr-F",undef); - if( $corrFactor ){ - $power = $dtime ? sprintf(" %4.1f %s",3600*$denergy*$corrFactor/$dtime,$si_units{power}[$hash->{units}]) : "-"; - readingsBulkUpdate($hash,$reading."-c", - shelly_energy_fmt($hash,$denergy*$corrFactor,"Wh") - .sprintf(" (%7.4f f=%4.3f) ",$energy,$corrFactor) - .$power, - undef, $TimeStamp); - } + + $energyOld=ReadingsVal($hash->{NAME},$reading,undef); + if( $energyOld ){ + $energyOld=~ /.*\((.*)\).*/; + $denergy = $energy - $1; # energy used in this periode, may be negative! + }else{ + $denergy = 0; # if(abs($denergy) < 0.001); + } + + my $power = $dtime ? sprintf(" %4.1f %s",3600*$denergy/$dtime,$si_units{power}[$hash->{units}]) : "-"; + readingsBulkUpdate($hash,$reading, + shelly_energy_fmt($hash,$denergy,"Wh").sprintf(" (%7.4f) ",$energy).$power, + undef, $TimeStamp); + #--- corrected values ? + my $corrFactor = AttrVal($hash->{NAME},"PeriodsCorr-F",undef); + if( $corrFactor ){ + $power = $dtime ? sprintf(" %4.1f %s",3600*$denergy*$corrFactor/$dtime,$si_units{power}[$hash->{units}]) : "-"; + readingsBulkUpdate($hash,$reading."-c", + shelly_energy_fmt($hash,$denergy*$corrFactor,"Wh").sprintf(" (%7.4f f=%4.3f) ",$energy,$corrFactor).$power, + undef, $TimeStamp); + } } - return undef; + return undef; } @@ -4132,14 +5210,14 @@ sub shelly_delta_energy { # # shelly_energy_fmt - format the energy reading # -# Parameter hash, energy value, unit of shellies energy-value +# Parameter hash, energy value, unit of shellies energy-value # ######################################################################################## -sub shelly_energy_fmt { +sub shelly_energy_fmt { my ($hash, $energy, $unit) = @_; # return $energy; my $showunits = AttrVal($hash->{NAME},"showunits","none"); - my $decimals=1; # no of decimals in output + my $decimals=1; # no of decimals in output my $name = $hash->{NAME}; if( $showunits eq "original" ){ @@ -4155,7 +5233,7 @@ sub shelly_energy_fmt { $unit = "Wh"; if( $showunits eq "none" ){ $unit = ""; # in Wh - return $energy; + return $energy; }elsif( $showunits eq "normal" ){ $decimals += 1; # nothing more to do here @@ -4169,67 +5247,45 @@ sub shelly_energy_fmt { }else{ return "Error: wrong unit"; } - $decimals = 1 if( $energy == 0 ); + $decimals = 1 if( $energy == 0 ); $decimals = "%1.".$decimals."f"; # e.g. %1.4f return( sprintf("$decimals %s",$energy, $unit ) ); -} +} #END# shelly_energy_fmt() ######################################################################################## # -# Shelly_dim - Set Shelly dimmer state -# acts as callable program Shelly_dim($hash,$channel,$cmd) -# and as callback program Shelly_dim($hash,$channel,$cmd,$err,$data) -# -# Parameter hash, channel = 0,1 cmd = command +# Shelly_response - processing the response of calls to the Shelly +# +# Parameter: $param, $jhash # ######################################################################################## - sub Shelly_dim { - my ($hash, $channel, $cmd, $err, $data) = @_; +sub Shelly_response { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $comp = $param->{comp}; + my $cmd = $param->{cmd}; + my $urlcmd=$param->{urlcmd}; my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; - my $net = $hash->{READINGS}{network}{VAL}; - return - if( !$net || $net !~ /connected to/ ); - - my $model = AttrVal($name,"model","generic"); - my $creds = Shelly_pwd($hash); - - if( $hash && !$err && !$data ){ - my $url = "http://$creds".$hash->{TCPIP}."/$channel$cmd"; - Log3 $name,4,"[Shelly_dim] issue a non-blocking call to $url"; #4 - HttpUtils_NonblockingGet({ - url => $url, - timeout => AttrVal($name,"timeout",4), - callback => sub($$$){ Shelly_dim($hash,$channel,$cmd,$_[1],$_[2]) } - }); - return undef; - }elsif( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_dim",$err); - return; - } - Log3 $name,5,"[Shelly_dim] device $name has returned data $data"; + my $model= AttrVal($name,"model","generic"); + my $timer; + #processing incoming data + Log3 $name,4,"[Shelly_response] device $name has returned JSON for component $comp to set $cmd"; + + #--------------------------- + if( $comp eq "dim" ){ + Log3 $name,4,"[Shelly_response:dim] ok"; + #************************* + my $ison = $jhash->{'ison'}; + my $hastimer = $jhash->{'has_timer'}; + my $onofftimer = $jhash->{'timer_remaining'}; + my $source = $jhash->{'source'}; + # more readings by shelly_dim-answer: timer_started, timer_duration, mode, transition + + #************************* + if(0 && $cmd =~ /\?turn=((on)|(off))/ ){ + Log3 $name,0,"ERRRRRRORRRR [Shelly_dim] running for on or off command shall be "; - # extracting json from data - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - if( ($model =~ /shellyrgbw.*/) && ($data =~ /Device mode is not dimmer!/) ){ - Shelly_error_handling($hash,"Shelly_dim","is not a dimmer"); - }else{ - Shelly_error_handling($hash,"Shelly_dim","invalid JSON data"); - } - return; - } - - my $ison = $jhash->{'ison'}; - my $bright = $jhash->{'brightness'}; - my $hastimer = $jhash->{'has_timer'}; - my $onofftimer = $jhash->{'timer_remaining'}; - my $source = $jhash->{'source'}; - # more readings by shelly_dim-answer: timer_started, timer_duration, mode, transition - - if( $cmd =~ /\?turn=((on)|(off))/ ){ my $cmd2 = $1; $ison =~ s/0|(false)/off/; $ison =~ s/1|(true)/on/; @@ -4243,14 +5299,19 @@ sub shelly_energy_fmt { if( $ison ne $cmd2 ) { Log3 $name,1,"[Shelly_dim] returns without success for device $name, cmd=$cmd but ison=$ison"; } - }elsif( $cmd =~ /\?brightness=(\d*)/){ - my $cmd2 = $1; - if( $bright ne $cmd2 ) { - Log3 $name,1,"[Shelly_dim] returns without success for device $name, desired brightness $cmd2, but device brightness=$bright"; - } - } - - readingsBeginUpdate($hash); + } + #************************* + + if( $cmd =~ /\?brightness=(\d*)/){ + Log3 $name,4,"[Shelly_dim] running for brightness command"; + my $val = $1; + my $bright = $jhash->{brightness}; + if( $bright ne $val ) { + Log3 $name,1,"[Shelly_dim] returns without success for device $name, desired brightness $val, but device brightness=$bright"; + } + } + + readingsBeginUpdate($hash); if( $jhash->{'overpower'} ){ #not supported by ShellyDimmer2 bulb/dimmer my $overpower = $jhash->{'overpower'}; Log3 $name,1,"[Shelly_dim] device $name switched off automatically because of overpower signal" @@ -4259,371 +5320,340 @@ sub shelly_energy_fmt { if( $shelly_models{$model}[3] > 0); } readingsEndUpdate($hash,1); - - #-- Call status after switch. - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+0.5, "Shelly_status", $hash,0); - my $duration=ReadingsNum($name,"transition",10000)/1000; - InternalTimer(time()+$duration, "Shelly_status2", $hash,0); - return undef; -} + Shelly_status($hash); + $timer = 0.25 + ReadingsNum($name,"transition",10000)/1000; + #************************* + }elsif( $comp eq "onoff" ){ + my $onofftimer = 0; + if( defined($jhash->{was_on}) ){ # response by Gen2 fw + my $oldState = $jhash->{was_on}; + $oldState =~ s/0|(false)/off/; + $oldState =~ s/1|(true)/on/; + $onofftimer = $hash->{helper}{timer} if( defined($hash->{helper}{timer}) ); + my $msg = "Successfull, device $name was $oldState "; + $msg .= ", device switched with timer of $onofftimer seconds" if( $onofftimer ); + Log3 $name,4,"[Shelly_response:onoff] $msg"; + }else{ + my $ison = $jhash->{ison}; + my $hastimer = undef; + my $source = $jhash->{source}; + my $overpower = $jhash->{overpower}; -######################################################################################## -# -# Shelly_updown - Move roller blind -# acts as callable program Shelly_updown($hash,$cmd) -# and as callback program Shelly_updown($hash,$cmd,$err,$data) -# -# Parameter hash, channel = 0,1 cmd = command -# -######################################################################################## + $ison =~ s/0|(false)/off/; + $ison =~ s/1|(true)/on/; - sub Shelly_updown { - my ($hash, $cmd, $err, $data) = @_; - my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; - my $net = $hash->{READINGS}{network}{VAL}; - return - if( !$net || $net !~ /connected to/ ); - - Log3 $name,5,"[Shelly_updown] is called with command $cmd "; - - my $model = AttrVal($name,"model","generic"); - my $creds = Shelly_pwd($hash); - - #-- empty cmd parameter - $cmd = "" - if( !defined($cmd) ); - - if( $hash && !$err && !$data ){ - my $url = "http://$creds".$hash->{TCPIP}."/roller/0".$cmd; - Log3 $name,4,"[Shelly_updown] issue a non-blocking call to $url"; - HttpUtils_NonblockingGet({ - url => $url, - timeout => AttrVal($name,"timeout",4), - callback => sub($$$){ Shelly_updown($hash,$cmd,$_[1],$_[2]) } - }); - return undef; - }elsif( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_updown",$err); - return; - } - Log3 $name,5,"[Shelly_updown] has obtained data $data"; - - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - if( ($model =~ /shelly(plus|pro)?2.*/) && ($data =~ /Device mode is not roller!/) ){ - Shelly_error_handling($hash,"Shelly_updown","is not in roller mode"); + if( defined($jhash->{has_timer}) ){ + $hastimer = $jhash->{has_timer}; + if( defined($jhash->{timer_remaining}) ){ + $onofftimer = $jhash->{timer_remaining}; + }else{ + $onofftimer = "-"; # no remaining time given by old fw eg Shelly4pro + } + } + + # check on successful execution + $urlcmd =~ m/\/(\d)\?turn=(o.*)(\&timer=)?(\d+)?/; # + my $channel = $1; + my $turnstate=$2; #Debug $turnstate; + $onofftimer = $4 if( $model eq "shelly4" && $urlcmd=~/timer/ ); # get remaining time from command (is not supported by /status call) + + Log3 $name,1,"[Shelly_response:onoff] returns with problem for device $name, timer not set" if( $4 && !$hastimer ); + + $urlcmd =~ m/turn=(on|off)/; Debug $1; + Log3 $name,1,"[Shelly_response:onoff] returns without success for device $name, cmd=$urlcmd but ison=$ison vs $1" if( $ison ne $1 ); + + if( defined($overpower) && $overpower eq "1") { + Log3 $name,1,"[Shelly_response:onoff] device $name switched off automatically because of overpower signal"; + } + + my $subs = ($shelly_models{$model}[0] == 1) ? "" : "_".$channel; + + Log3 $name,4,"[Shelly_response:onoff] received callback from $name channel $channel is switched $ison, " + .($hastimer?"timer is set to $onofftimer sec":"no timer set"); + readingsBeginUpdate($hash); + if( $model ne "shelly4" ){ + $onofftimer .= $si_units{time}[$hash->{units}]; + readingsBulkUpdateMonitored($hash,"source".$subs,$source); # not supported/old fw + }else{ + $onofftimer = $hastimer?$onofftimer.$si_units{time}[$hash->{units}]:"--"; + } + readingsBulkUpdateMonitored($hash,"timer".$subs,$onofftimer); + + + +if(0){ + if( $shelly_models{$model}[0] == 1 ){ + readingsBulkUpdateMonitored($hash,"state",$ison); }else{ - Shelly_error_handling($hash,"Shelly_updown","invalid JSON data"); + readingsBulkUpdateMonitored($hash,"state","OK"); } - return; - } - - #-- immediately after starting movement - if( $cmd ne ""){ - #-- open 100% or 0% ? - my $pctnormal = (AttrVal($name,"pct100","open") eq "open"); - my $targetpct = $hash->{TARGETPCT}; - my $targetposition = $targetpct; - if( $targetpct == 100 ){ - $targetposition = $pctnormal ? "open" : "closed"; - }elsif( $targetpct == 0 ){ - $targetposition = $pctnormal ? "closed" : "open"; - } - Log3 $name,5,"[Shelly_updown] $name: pct=$targetpct"; - readingsBeginUpdate($hash); - readingsBulkUpdateMonitored($hash,"state",$hash->{MOVING}); - readingsBulkUpdateMonitored($hash,"pct",$targetpct); - readingsBulkUpdateMonitored($hash,"position",$targetposition); - readingsEndUpdate($hash,1); + readingsBulkUpdateMonitored($hash,"relay".$subs,$ison); # also "light" - #-- perform first update after starting of drive - $hash->{DURATION} = 5 if( !$hash->{DURATION} ); # duration not provided by Gen2 - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+0.5, "Shelly_status", $hash); # update after starting - # next update after expected stopping of drive + offset (at least 1 sec) - InternalTimer(time()+$hash->{DURATION}+1.5, "Shelly_status2", $hash,1); - } - return undef; -} - -sub Shelly_status2($){ - my ($hash) =@_; - Shelly_status($hash); -} - - -######################################################################################## -# -# Shelly_onoff - Switch Shelly relay -# acts as callable program Shelly_onoff($hash,$channel,$cmd) -# and as callback program Shelly_onoff($hash,$channel,$cmd,$err,$data) -# -# Parameter hash, channel = 0,1 cmd = command -# example: /relay/0?turn=on&timer=4 works for Gen1 and Gen2 -# /rpc/Switch.Set?id=0&on=true&toggle_after=4 Gen2 only (not realized) -# -######################################################################################## - - sub Shelly_onoff { - my ($hash, $channel, $cmd, $err, $data) = @_; - my $name = $hash->{NAME}; - my $state = $hash->{READINGS}{state}{VAL}; - my $net = $hash->{READINGS}{network}{VAL}; - - Log3 $name,6,"[Shelly_onoff] try to execute command $cmd channel $channel for device $name ($state, $net)"; - return "Unsuccessful: Network Error for device $name, try device get status " - if( !$net || $net !~ /connected to/ ); - - my $model = AttrVal($name,"model","generic"); - my $creds = Shelly_pwd($hash); - - if( $hash && !$err && !$data ){ - my $callback; - my $url = "http://$creds".$hash->{TCPIP}; - if($shelly_models{$model}[4]<2){ - $url .= "/relay/$channel$cmd"; - $callback="/relay/$channel$cmd"; - }else{ # eg Wall-Display - $cmd =~ /\?id=(\d)/; - $callback = $url."/rpc/Switch.GetStatus?id=".$1; - $url .= $cmd; - } - Log3 $name,4,"[Shelly_onoff] issue a non-blocking call to $url; callback to Shelly_onoff with command $callback"; - HttpUtils_NonblockingGet({ - url => $url, - timeout => AttrVal($name,"timeout",4), - callback => sub($$$){ Shelly_onoff($hash,$channel,$callback,$_[1],$_[2]) } - }); - return undef; - }elsif( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_onoff",$err); - return; - } - - #processing incoming data - Log3 $name,5,"[Shelly_onoff:callback] device $name has returned data \n$data"; - - # extracting json from data - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - if( ($model =~ /shelly(plus)?2.*/) && ($data =~ /Device mode is not relay!/) ){ - Shelly_error_handling($hash,"Shelly_onoff","is not in relay mode"); - }elsif( $data =~ /Bad timer/ ){ - Shelly_error_handling($hash,"Shelly_onoff","Bad timer argument"); - }else{ - Shelly_error_handling($hash,"Shelly_onoff","invalid JSON data"); - } - return; - } - - my $onofftimer = 0; - if( $jhash->{'was_on'} ){ - my $was_on = $jhash->{'was_on'}; - }else{ - my $ison = $jhash->{'ison'}; - my $hastimer = undef; - my $timerstr = "-"; - my $source = $jhash->{'source'}; - my $overpower = $jhash->{'overpower'}; - - $ison =~ s/0|(false)/off/; - $ison =~ s/1|(true)/on/; - - if( $jhash->{'has_timer'} ){ - $hastimer = $jhash->{'has_timer'}; - $onofftimer = $jhash->{'timer_remaining'}; - $timerstr = $onofftimer.$si_units{time}[$hash->{units}]; - } - - # check on successful execution - $cmd =~ /\/relay\/(\d)\?turn=(on|off)(\&timer=)?(\d+)?/; - $channel = $1; - - Log3 $name,1,"[Shelly_onoff] returns with problem for device $name, timer not set" if( $4 && $hastimer ne "1"); - Log3 $name,1,"[Shelly_onoff] returns without success for device $name, cmd=$cmd but ison=$ison" if( $ison ne $2 ); - - if( defined($overpower) && $overpower eq "1") { - Log3 $name,1,"[Shelly_onoff] device $name switched off automatically because of overpower signal"; - } - - my $subs = ($shelly_models{$model}[0] == 1) ? "" : "_".$channel; - - Log3 $name,4,"[Shelly_onoff:callback] received callback from $name channel $channel is switched $ison, " - .($hastimer?"timer is set to $onofftimer sec":"no timer set"); - readingsBeginUpdate($hash); - readingsBulkUpdateMonitored($hash,"timer".$subs,$timerstr); - readingsBulkUpdateMonitored($hash,"source".$subs,$source) if( $model ne "shelly4" ); # not supported/old fw - - if( $shelly_models{$model}[0] == 1 ){ - readingsBulkUpdateMonitored($hash,"state",$ison); - }else{ - readingsBulkUpdateMonitored($hash,"state","OK"); - } - readingsBulkUpdateMonitored($hash,"relay".$subs,$ison); - - readingsBulkUpdateMonitored($hash,"overpower".$subs,$overpower) + readingsBulkUpdateMonitored($hash,"overpower".$subs,$overpower) if( $shelly_models{$model}[3]>0 && $model ne "shelly1" ); - readingsEndUpdate($hash,1); - } #------ - - #-- Call status after switch. - if( $hash->{INTERVAL}>0 ){ - $onofftimer = ($onofftimer % $hash->{INTERVAL}) + 0.5; #modulus - } - RemoveInternalTimer($hash,"Shelly_status"); - InternalTimer(time()+$onofftimer, "Shelly_status", $hash,0); - - return undef; } + readingsEndUpdate($hash,1); + } + $timer=0.40; + # switching dimable devices on or off also have 'brightness' and 'transition' + my $brightness = $jhash->{brightness}; + my $transition = $jhash->{transition}; + + #--------------------------- + }elsif( $comp eq "updown" ){ + delete $hash->{CMD}; + $timer=1.55; # wait until Shelly has passed first measurement periode + # Shelly_status($hash); + # $timer=$hash->{DURATION}; + #--------------------------- + }elsif( $comp =~ /config/ ){ + $timer=1.25; + + # "reboot" + if( $cmd eq "/reboot" ){ + # Gen1 + my $ok = $jhash->{ok}; + if( $ok != 0 ){ + Log3 $name,4,"[Shelly_response:config] device $name is rebooting "; + readingsSingleUpdate($hash,"state","rebooting",1); + $timer=15.0; + }else{ + Log3 $name,2,"[Shelly_response:config] device $name was called for reboot, but answers with $ok "; + } + + # "update" + }elsif( $cmd eq "/ota" ){ + #update Gen1 + my $status = $jhash->{status}; + my $has_update = $jhash->{has_update}; + if( $has_update != 0 ){ + Log3 $name,4,"[Shelly_response:config] device $name is $status, update is $has_update "; + readingsSingleUpdate($hash,"state",$status,1); + $timer=30; + }else{ + Log3 $name,2,"[Shelly_response:config] device $name was called for update, but no update present (state is $status) "; + } + + # "calibrate" roller ********* this is not tested ************** + }elsif( $cmd eq "/roller" && $urlcmd =~ /calibrate/){ + readingsSingleUpdate($hash,"state","calibrating",1); + $timer=150.0; + + + # "calibrate" dimmer ********* this is not final ************** + }elsif( $cmd eq "/settings" && $urlcmd =~ /calibrate/){ + my $calibrated = $jhash->{calibrated}; + if( $calibrated != 0 ){ + Log3 $name,2,"[Shelly_response:config] device $name is called for calibration"; + readingsSingleUpdate($hash,"state","calibrating",1); + $timer=15.0; + }else{ + Log3 $name,6,"[Shelly_response:config] $name: device was called for calibration, but is not calibrated"; + Log3 $name,6,"[Shelly_response:config] $name: Start Calibration from Shellies WEB-UI"; + return; + } + + # Gen2 Sys.SetConfig Cover.SetConfig Wifi.SetConfig etc. + }elsif( $cmd =~ /SetConfig/ ){ + if( defined( $jhash->{restart_required}) ){ + Log3 $name,1,"[Shelly_response:config] device $name has set Config successfull, Restart required: ".($jhash->{restart_required}?"YES":"NO"); + } + #call settings + Shelly_HttpRequest( $hash,"/rpc/Shelly.GetConfig",undef,"Shelly_settings2G","config" ); + return; + + + # Gen2 Switch.ResetCounters Cover.ResetCounters + }elsif( $cmd =~ /ResetCounter/ ){ + if( defined($jhash->{aenergy}{total}) ){ + $comp =~ /(\d)/; + my $id = $1; + my $subs = (defined(ReadingsNum($name,"energy_0",undef))?"\_$id":""); + Log3 $name,3,"[Shelly_response:config] device $name has reset counter \'energy$subs\' successfull"; + readingsSingleUpdate($hash,"energy$subs",$jhash->{aenergy}{total},1); + $timer=1; + } + + # Gen2 Shelly.Reboot + }elsif( $cmd =~ /Shelly.Reboot/ ){ + if( defined( $jhash->{cover}) && $jhash->{cover} eq "successfull" ){ + Log3 $name,2,"[Shelly_response:config] device $name is rebooting"; + readingsSingleUpdate($hash,"state","rebooting",1); + $timer=15; + } + + # Gen2 Shelly.Update + }elsif( $cmd =~ /Shelly.Update/ ){ + if( defined( $jhash->{cover}) && $jhash->{cover} eq "successfull" ){ + Log3 $name,2,"[Shelly_response:config] device $name is updating"; + readingsSingleUpdate($hash,"state","updating",1); + $timer=30; + } + }else{ + Log3 $name,4,"[Shelly_response:config] device $name has been processed"; + } + + + # GET CONFIG + #--------------------------- + }elsif( $comp eq "getconfig" ){ + Log3 $name,4,"[Shelly_response:getconfig] device $name processing call \"$cmd$urlcmd\" ";#4 + $timer=1.25; + #-- isolate channel and register name + $urlcmd =~ /.*\/(\d)\?(.*)/; + my $chan= $1; + my $reg = $2; + my $val = $jhash->{$reg}; + Log3 $name,4,"[Shelly_response:getconfig] $name: isolated register=$reg, channel=$chan, value=$val";#4 + + ## $chan = $shelly_models{$model}[7] == 1 ? "" : "[channel $chan]"; + + if( defined($val) ){ + Log3 $name,4,"[Shelly_response:getconfig] device $name result is: register=\'$reg\' channel=\'$chan\' value=\'$val\' "; + readingsSingleUpdate($hash,"config","$reg=$val $chan",1); + }else{ + Log3 $name,4,"[Shelly_response:getconfig] device $name no result found for register $reg $chan"; + readingsSingleUpdate($hash,"config","register \'$reg\' not found or empty $chan",1); + } + return undef; # do not perform call for status + } + #--------------------------- + readingsSingleUpdate($hash,"/_nextUpdateTimer",$timer.$si_units{time}[$hash->{units}],1) + if( AttrVal($name,'timeout',undef) ); ## for debugging only + #-- Call status after switch. + Log3 $name,4,"[Shelly_response] scheduled status call for $name in $timer sec"; + RemoveInternalTimer($hash,"Shelly_status"); + InternalTimer(time()+$timer, "Shelly_status", $hash); + return undef; +} # END Shelly_response() ######################################################################################## # -# Shelly_webhook - Retrieve webhook data -# acts as callable program Shelly_webhook($hash,$cmd) -# or Shelly_webhook($hash) with $cmd via $hash -# and as callback program Shelly_webhook($hash,$cmd,$err,$data) -# -# Parameter hash, $cmd: Create,Check,List,Update,Delete a webhook +# Shelly_webhook_create - Create a set of webhook +# +# Parameter: hash +# cmd info, all or a number # ######################################################################################## - sub Shelly_webhook { - my ($hash, $cmd, $err, $data) = @_; +sub Shelly_webhook_create { + my ($hash,$cmd) = @_; my $name = $hash->{NAME}; -return if( $hash->{INTERVAL} == 0 ); - my $state = $hash->{READINGS}{state}{VAL}; - my $net = $hash->{READINGS}{network}{VAL}; - - # check if net is 'not connected' or 'connected to ...' - if( $net && $net =~ /not/ ){ - Log3 $name,1,"[Shelly_webhook] Error $name: network status is not connected"; - return; - } + my $number = -1; + #return "Error" unless( $cmd =~ /info|all/ || $cmd =~ /\d/ ); - #-- undefined or empty cmd parameter - if( !defined($cmd) ){ - Log3 $name,6,"[Shelly_webhook] was called for device $name, but without command (Create..., Update, Delete, List)"; - $cmd = $hash->{CMD}; - return if( !$cmd); + if( $cmd eq "info"){ + Log3 $name,2,"[Shelly_webhook_create] generating list of possible webhook(s) for device $name"; + }elsif($cmd eq "all" ){ + Log3 $name,2,"[Shelly_webhook_create] creating all webhooks for device $name"; + delete $hash->{helper}{actionCreate}; + }elsif( $cmd =~ /\d/ ){ + $number = $cmd; + Log3 $name,2,"[Shelly_webhook_create] creating webhook number $number for device $name"; + }else{ + Log3 $name,2,"[Shelly_webhook_create] $name: wrong parameter"; + return "Error"; } - Log3 $name,4,"[Shelly_webhook] proceeding with command \'$cmd\' for device $name". (!$data?", no data given":", processing data"); my $model = AttrVal($name,"model","generic"); my $gen = $shelly_models{$model}[4]; # 0 is Gen1, 1 or 2 is Gen2 my $creds = Shelly_pwd($hash); my $timeout = AttrVal($name,"timeout",4); my $mode = AttrVal($name,"mode","relay"); # we need mode=relay for Shelly*1-devices - - # Calling as callable program: check if err and data are empty - if( $hash && !$err && !$data ){ - Log3 $name,7,"[Shelly_webhook] device $name will be called by Webhook."; - - my $URL = "http://$creds".$hash->{TCPIP}; - $URL .=($gen>=1?"/rpc/Webhook.":"/settings/actions"); #Gen2 : Gen1 - - if( $cmd eq "Create" ){ - $URL .= "Create" if( $gen >= 1 ); - }elsif( $cmd eq "Update" ){ - $URL .= "Update?id=1"; - }elsif( $cmd eq "Delete" ){ - $URL .= "List"; # callback-cmd is "Delete" - }elsif( $cmd eq "Check" ){ - $URL .= "List"; # callback-cmd is "Check" - }elsif( $cmd eq "Count" ){ - $URL .= "List"; # callback-cmd is "Count" - }else{ - $URL .= $cmd; - } - #---------CHECK, UPDATE, DELETE Webhooks------------- - if( $cmd ne "Create" ){ #Check, Count, Update, Delete - Log3 $name,5,"[Shelly_webhook] issue a non-blocking call to $URL, callback with command \'$cmd\' "; - HttpUtils_NonblockingGet({ - url => $URL, - timeout => $timeout, - callback => sub($$$){ Shelly_webhook($hash,$cmd,$_[1],$_[2]) } - }); - return undef; - - #---------CREATE Webhooks------------- - }elsif( $cmd eq "Create" ){ - - my $urls = ""; - my $event = ""; - my $compCount=0; # number of components in device - my $eventsCount=0; # number of events + my $html = ""; + my $count= 0; + my $URL =($gen>=1?"/rpc/Webhook.Create":"/settings/actions"); #Gen2 : Gen1 + my $enable = ($cmd eq "all"?"false":"true"); - my ($component,$element); - foreach $component ( $mode, "input", "emeter", "pm1", "touch", "addon" ){ - Log3 $name,5,"[Shelly_webhook] $name: check number of components for component=$component"; + my $urls = ""; + my $event = ""; + my $action; # name of the action + my $compCount=0; # number of components in device + my $eventsCount=0; # number of events + my ($component,$element); + + foreach $component ( $mode, "light", "input", "emeter", "pm1", "touch", "sensor", "addon" ){ + Log3 $name,4,"[Shelly_webhook_create] $name: check number of components for component=$component"; if( $component eq "relay" ){ $compCount = $shelly_models{$model}[0]; }elsif( $component eq "roller" ){ $compCount = $shelly_models{$model}[1]; + }elsif( $component eq "light" && $gen>0 ){ + $compCount = $shelly_models{$model}[2]; + }elsif( $component eq "white" && $gen==0 ){ # eg Shellybulb in white mode + $compCount = $shelly_models{$model}[2]; + }elsif( $component eq "color" && $gen==0){ # eg. ShellyRGBW in color mode + $compCount = $shelly_models{$model}[7]; }elsif( $component eq "input" && AttrVal($name,"showinputs","show") eq "show" && $mode ne "roller" ){ # ShellyPlus2PM in roller mode does not support Actions for both inputs, even with detached inputs. # We don't care, because we can use actions on 'opening' and 'closing' $compCount = abs($shelly_models{$model}[5]); # number of inputs on ShellyPlug is -1, because it's a button, not an wired input }elsif( $component eq "emeter" && $model eq "shellypro3em" ){ - $compCount = 1; + $compCount = 1; }elsif( $component eq "pm1" && $model eq "shellypmmini" ){ $compCount = 1; - }elsif( $component eq "touch" && $model =~ /walldisplay/ ){ - $compCount = 1; - }elsif( $component eq "white" && $model eq "shellybulb" ){ + }elsif( $component =~ /touch|sensor/ && $model =~ /walldisplay/ ){ $compCount = 1; }elsif( $component eq "addon" && ReadingsVal($name,"temperature_0", undef) ){ # we have an addon and at least one temperature sensor - #Debug "start processing ADDON"; $compCount = 5; #max number of sensors supported }else{ $compCount = 0 ; } - Log3 $name,5,"[Shelly_webhook] $name: the number of \'$component\' is compCount=$compCount"; - + Log3 $name,4,"[Shelly_webhook_create] $name: the number of \'$component\' is compCount=$compCount"; + for( my $c=0;$c<$compCount;$c++ ){ - Log3 $name,5,"[Shelly_webhook] $name: processing component $c of $component"; - if( $component eq "input"){ + Log3 $name,4,"[Shelly_webhook_create] $name: processing component $c of $component"; + if( $component eq "input" && $gen > 0){ my $subs= $compCount>1 ? "_$c\_mode" : "_mode" ; $element = ReadingsVal($name,"input$subs","none"); #input type: switch or button if( $element eq "none" ){ - Log3 $name,3,"[Shelly_webhook] $name: Error: Reading \'input.*mode\' not found"; + Log3 $name,3,"[Shelly_webhook_create] $name: Error: Reading \'input.*mode\' not found"; return; } - Log3 $name,5,"[Shelly_webhook] $name: input mode no $c is \'$element\' "; - $element =~ /(\S+?)\s.*/; # get only characters from first string of reading - $element = $1; + Log3 $name,4,"[Shelly_webhook_create] $name: input mode no $c is \'$element\' "; + $element =~ /(\S+?)\s.*/; # get only characters from first string of reading: 'button' or 'switch' + $element = $1; # momentary or toggle }elsif( $component eq "emeter" || $component eq "pm1"){ - $element = $component; - ## $element = "emeter"; ## ?? PM1 + $element = $component; }elsif( $component eq "addon"){ - #Debug "processing ADDON c=$c"; $element = $component; next unless( ReadingsVal($name,"temperature_$c", undef) ); }elsif( $gen == 0){ # Gen 1 - $element = $model; + $element = $model; }else{ $element = $component; } - - $eventsCount = $#{$shelly_events{$element}}; # $#{...} gives highest index of array - Log3 $name,5,"[Shelly_webhook] $name: processing evtsCnt=$eventsCount events for \'$element\'";#5 - - for( my $e=0; $e<=$eventsCount; $e++ ){ - if( $cmd eq "Create" ){ - $event = $shelly_events{$element}[$e]; - $urls = ($gen?"?cid=$c":"?index=$c"); # component id, 0,1,... - $urls = "?cid=10$c" if( $element eq "addon" ); - $urls .= "&name=%22_". uc($event) ."_%22" if( $gen == 1 ); # name of the weblink (Gen2 only) - $urls .= ($gen?"&event=%22$event%22":"&name=$event"); - $urls .= ($gen?"&enable=true":"&enabled=true"); - my( $WebHook,$error ) = Shelly_actionWebhook($hash,$element,$c,$e); # creating the &urls= command + $eventsCount = $#{$shelly_events{$element}}; # $#{...} gives highest index of array %shelly_events + $eventsCount++; + Log3 $name,4,"[Shelly_webhook_create] $name: processing evtsCnt=$eventsCount events for \'$element\'";#5 + + for( my $e=0; $e<$eventsCount; $e++ ){ + $event = $shelly_events{$element}[$e]; + $action = uc($event); + # $action =~ s/\./_$c\./ if( $eventsCount>1 ); # add comp-id to the actions-name + $action =~ s/\./_$c\./ if( $compCount>1 ); # add comp-id to the actions-name + $action = "_".$action."_"; # add _ to the name + if( $gen >= 1 ){ + $urls = "?cid=$c"; + $urls = "?cid=10$c" if( $element eq "addon" ); + $urls .= "&event=%22$event%22"; # %22 will get quotes + $urls .= "&enable=$enable"; + $urls .= "&name=%22$action%22"; # name of the weblink (Gen2 only) + $urls =~ s/\%22//g if( $model =~ /walldisplay/ ); # is there a bug? + }else{ + $urls = "?index=$c"; + $urls .= "&name=$event"; + $urls .= "&enabled=$enable"; + } + + Log3 $name,4,"[Shelly_webhook_create] $name: processing event=$e $event for \'$element\': \n$urls";#5 + if( $cmd ne "info" ){ + my $cc = $compCount>1?$c:undef; + my( $WebHook,$error ) = Shelly_actionWebhook($hash,$element,$cc,$e); # creating the &urls= command return if($error); $urls .= $WebHook; @@ -4632,206 +5662,385 @@ return if( $hash->{INTERVAL} == 0 ); $urls .= "&condition=%22ev.act_power%20%3c%20-200%22" if( 0 && $e==0 ); # %3c < $urls .= "&condition=%22ev.act_power%20%3e%20-100%22" if( 0 && $e==1 ); # %3e > # only first emeter-action (activ power) is enabled - $URL =~ s/enable\=true/enable\=false/ if( $e > 0 ); + $URL =~ s/enable\=true/enable\=false/ if( $e > 0 ); } + } + Log3 $name,4,"[Shelly_webhook_create] $name component=$element $c count=$count event=$e -----------------"; + if( $cmd eq "info" ){ + $html .= "$count $component $c $event "; + }elsif( $cmd eq "all" ){ + Log3 $name,4,"[Shelly_webhook_create] webhook #$number: write the non-blocking call to stack: \n$URL$urls"; + $hash->{helper}{actionCreate}[$count] = $urls; + }elsif( $number == $count ){ + Log3 $name,4,"[Shelly_webhook_create] webhook #$number: process the non-blocking call: \n$URL$urls"; + Shelly_HttpRequest($hash,$URL,$urls,"Shelly_webhook_update","procCreate",0); + return; + }else{ + Log3 $name,4,"[Shelly_webhook_create] skipping: $count is not eq to $number"; } - Log3 $name,1,"[Shelly_webhook] $name $cmd component=$element count=$c event=$e"; - Log3 $name,1,"[Shelly_webhook] issue a non-blocking call to \n$URL$urls"; - HttpUtils_NonblockingGet({ - url => $URL.$urls, - timeout => $timeout, - callback => sub($$$){ Shelly_webhook($hash,$cmd,$_[1],$_[2]) } - }); + $count++; } } - } - return undef; - } # cmd==Create - - # Error - }elsif( $hash && $err ){ - Shelly_error_handling($hash,"Shelly_webhook",$err); - return; } - ################################################# $hash && $data - # Answer: processing the received webhook data - Log3 $name,5,"[Shelly_webhook] device $name called by Webhook.$cmd has returned data $data"; - - # extracting json from data - my $json = JSON->new->utf8; - my $jhash = eval{ $json->decode( $data ) }; - if( !$jhash ){ - Shelly_error_handling($hash,"Shelly_webhook","invalid JSON data"); - return; - } - # in any case get webhook version. In some cases (eg no Update performed) we have not received an answer. - my $webhook_v = ( defined($jhash->{'rev'}) ? $jhash->{'rev'} : ReadingsVal($name,"webhook_ver",0) ); - - # get number of webhooks - my $hooksCount = ( defined($jhash->{'hooks'}) ? @{$jhash->{'hooks'}} : ReadingsVal($name,"webhook_cnt",0) ); - - #processing the webhook data for the different commands - Log3 $name,5,"[Shelly_webhook] processing the webhook data for command=$cmd"; - - #---------------------Read number of webhooks from 'List' - if( $cmd eq "Count" ){ - - - #---------------------Check the received data from 'List' if the webhook has to be changed - }elsif( $cmd eq "Check" ){ - -if(1){ # first of all, get number of webhooks - if( defined $jhash->{'hooks'} ){ - $hooksCount =@{$jhash->{'hooks'}}; - }else{ - #return if($hooksCount == 0); - $hooksCount = 0; - } - Log3 $name,5,"[Shelly_webhook] our counter says $hooksCount webhooks on shelly"; -} - - # parsing all webhooks and check for csrf-token - my $current_url; # the current url of webhook on the shelly - my $current_name; - my $urls; # the new urls string - - # are there webhooks on the shelly we don't know about? - if( (!AttrVal($name,"webhook",undef) || AttrVal($name,"webhook",undef) eq "none" ) && $jhash->{'hooks'}[0]{'urls'}[0] ){ - $current_url = $jhash->{'hooks'}[0]{'urls'}[0]; # get the first webhook url from shelly - $current_url =~ m/.*:([0-9]*)\/.*/; - my $fhemwebport = $1; - Log3 $name,4,"[Shelly_webhook] We have found a webhook with port no $fhemwebport on $name, but the webhook attribute is none or not set"; + if( $count == 0 ){ + Log3 $name,2,"[Shelly_webhook_create] $name: no actions to create"; return; - } - - # preparing the calling-url, we need this when looping - my $URL = "http://$creds".$hash->{TCPIP}; - $URL .= ($gen>0?"/rpc/Webhook.Update":"/settings/actions"); - # host_ip - my $host_ip = qx("\"hostname -I\""); # local - $host_ip =~ m/(\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?).*/; #extract ipv4-address - $host_ip = $1; - # port - my $host_port = InternalVal(AttrVal($name,"webhook","none"),"PORT",undef); - # CSFR-Token - my $token = InternalVal(AttrVal($name,"webhook","none"),"CSRFTOKEN",undef); - - Log3 $name,3,"[Shelly_webhook] $name: start parsing $hooksCount webhooks"; - my $flag; - for (my $i=0;$i<$hooksCount;$i++){ - $flag=0; - # 1. check name of webhook - $current_name = $jhash->{'hooks'}[$i]{'name'}; - Log3 $name,4,"[Shelly_webhook] $name: checking webhook \'$current_name\'"; - if( $current_name !~ /^_/ ){ # name of webhook does not start with '_' -> skipp - Log3 $name,5,"[Shelly_webhook] shellies $name name of webhook $i $current_name does not start with _ -> skipping"; - next; - } - $current_url = $jhash->{'hooks'}[$i]{'urls'}[0]; # get the url from shelly - $current_url =~ s/\%/\%25/g; # to make it compareable to webhook_url - Log3 $name,5,"[Shelly_webhook] shellies $name webhook $i is $current_url"; - # 2. check ip of webhook - if($current_url !~ /$host_ip/ ){ #skip this hook when refering to another host - Log3 $name,5,"[Shelly_webhook] shellies $name webhook $i is refering to another host $current_url -> skipping"; - next; - } - # 3. check/change CSRF-Token - if( $current_url =~ /.*\&fwcsrf=(csrf_\d*)/ ){ - if( $1 ne $token ){ - Log3 $name,5,"[Shelly_webhook] $name: old token=$1 , new token=$token "; - $current_url =~ s/(csrf_\d*)/$token/; #substitue token - $flag = 1; - } - } - # 4. check/change XHR - if( $current_url =~ /(XHR=1)/ ){ - Log3 $name,5,"[Shelly_webhook] $name: XHR removed "; - $current_url =~ s/(&XHR=1)//; #remove/change XHR-command - $flag = 1; - } - # 5. substitute '&' by %26 - $current_url =~ s/\&/\%26/g; - # 6. substitute spaces by '%2520', that will result in '%20' - $current_url =~ s/\s/\%2520/g; - # 7. write out change - if( $flag ){ - $urls = $URL; - $urls .= "?urls=[\"$current_url\"]"; # we use \" instead of %22 - $urls .= "&id=".$jhash->{'hooks'}[$i]{'id'}; - Log3 $name,3,"[Shelly_webhook] $name: $i issue a non-blocking call with callback-command \"Updated\":\n$urls"; #5 - HttpUtils_NonblockingGet({ - url => $urls, - timeout => $timeout, - callback => sub($$$){ Shelly_webhook($hash,"Updated",$_[1],$_[2]) } - }); - }else{ - Log3 $name,5,"[Shelly_webhook] $name: $i check is OK, nothing to do"; #5 - } - } - - #---------------------Delete all webhooks (get number of webhooks from received data) - }elsif($cmd eq "Delete" ){ - return if(!defined $hooksCount); # nothing to do if there are no hooks - my $h_name; - my $h_id; - my $h_urls0; - for (my $i=0;$i<$hooksCount;$i++){ - $h_name = $jhash->{'hooks'}[$i]{'name'}; - $h_id = $jhash->{'hooks'}[$i]{'id'}; - $h_urls0 = $jhash->{'hooks'}[$i]{'urls'}[0]; # we need this, when checking for forward ip-adress - - Log3 $name,5,"[Shelly_webhook] ++++ $name: checking webhook id=$h_id \'$h_name\' for deleting ++++"; - if( $h_name =~ /^_/ ){ - Log3 $name,5,"[Shelly_webhook] ++++ $name: deleting webhook \'$h_name\' ++++"; - my $url_ = "http://$creds".$hash->{TCPIP}."/rpc/Webhook.Delete?id=$h_id"; - Log3 $name,5,"[Shelly_webhook] url: $url_"; - HttpUtils_NonblockingGet({ - url => $url_, - timeout => $timeout, - callback => sub($$$){ Shelly_webhook($hash,"Killed",$_[1],$_[2]) } - }); - }else{ - Log3 $name,5,"[Shelly_webhook] ++++ $name: webhook \'$h_name\' not deleted ++++"; - } - } - - #---------------------endpoint when 'check' has updated a webhook - }elsif($cmd eq "Updated" ){ - #my $webhook_v = $jhash->{'rev'}; #we don't do this here, because of reversed sequence of callbacks - # nothing more to do here - - #---------------------endpoint when a webhook has been deleted - }elsif($cmd eq "Killed" ){ - $hooksCount--; - # nothing more to do here - - #---------------------endpoint when a webhook has been created: get id and version from data - }elsif($cmd =~ /Create/ ){ - if( defined($jhash->{'id'}) ){ - #retrieving webhook id - my $webhook_id = $jhash->{'id'}; - $hooksCount++; - Log3 $name,5,"[Shelly_webhook] $name hook created with id=".($webhook_id?$webhook_id:"").($webhook_v?", version is $webhook_v":""); - }else{ - my $error = "Error ".$jhash->{'code'}." occured: ".$jhash->{'message'}; - Log3 $name,1,"[Shelly_webhook] $name: $error" if $error; - } - } - readingsBeginUpdate($hash); - readingsBulkUpdateMonitored($hash,"webhook_ver",$webhook_v); - readingsBulkUpdateMonitored($hash,"webhook_cnt",$hooksCount); - readingsEndUpdate($hash,1); - Log3 $name,5,"[Shelly_webhook] shelly $name has $hooksCount webhooks".($webhook_v?", latest rev is $webhook_v":""); # No of hooks in Shelly-device - - return undef; -} + }elsif( $cmd ne "info" ){ + Log3 $name,1,"[Shelly_webhook_create] $name: start creating $count actions"; + $count--; # undo last inkrement + # start creating with last entry on stack + Shelly_HttpRequest($hash,$URL,$hash->{helper}{actionCreate}[$count],"Shelly_webhook_update","procCreate",$count); # on success, we receive data + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \" Done \" )", ""); + return; + }elsif( $cmd eq "info" ){ + $html = "Index   Component   Event $html"; + $html = "$html
Events $model
"; + return $html; + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"$html\" )", ""); + return; + } +} # END Shelly_webhook_create() ######################################################################################## # -# Shelly_webhookurl - Retrieve the url for a webhook -# acts as callable program Shelly_webhookurl($hash) -# Parameter hash, a =argument array +# Shelly_webhook_update - Update one or all actions of a Shelly +# +# Parameter: hash +# cmd 'all' or the id of the action +# +######################################################################################## + +sub Shelly_webhook_update { + my ($param,$jhash) = @_; + my $hash = $param->{hash}; + my $comp = $param->{comp}; + my $val = $param->{val}; + my $cmd = $param->{cmd}; + my $urlcmd=$param->{urlcmd}; + my $name = $hash->{NAME}; + my $model= AttrVal($name,"model","generic"); + my $gen = $shelly_models{$model}[4]; # 0 is Gen1, 1 or 2 is Gen2 + ############## + my $id; + Log3 $name,3,"[Shelly_webhook_update] $name: calling with comp=$comp".(defined($val)?" and val=[$val]":", without ID"); + if( $comp eq "proc" ){ + $val--; + if( $val < 0 ){ + delete $hash->{helper}{actionUpdate}; + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"Update finished\" )", ""); + return; + } + if( $gen > 0 ){ + # set webhook_ver (Gen2 only) + Log3 $name,4,"[Shelly_webhook_update] $name: [$val] processing the answer /rpc/Webhook.Update"; + my $rev = $jhash->{rev}; + if( !defined($rev) ){ + readingsSingleUpdate($hash,"error","action not changed",1); + }else{ + readingsSingleUpdate($hash,"webhook_ver",$rev,1); + } + } + $urlcmd=$hash->{helper}{actionUpdate}[$val]; + $urlcmd =~ s/\s/%20/g; # substitute space sign + $urlcmd =~ s/\&fwcsrf/%26fwcsrf/g; # substitute & sign + # $urlcmd =~ s/%/%25/g; # substitute % sign + Log3 $name,3,"[Shelly_webhook_update] $name: processing next action update index $val, command is $cmd and urlcmd=$urlcmd"; + Shelly_HttpRequest($hash,$cmd,$urlcmd,"Shelly_webhook_update","proc",$val); # on success, we receive data + return; + }elsif( $comp eq "procCreate" ){ + $val--; + if( $val < 0 ){ + delete $hash->{helper}{actionCreate}; + FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"Creating actions finished\" )", ""); + return; + } + if( $gen > 0 ){ + # set webhook_ver (Gen2 only) + Log3 $name,4,"[Shelly_webhook_update] $name: [$val] processing the answer /rpc/Webhook.Create"; + my $rev = $jhash->{rev}; + if( !defined($rev) ){ + readingsSingleUpdate($hash,"error","action not created",1); + }else{ + readingsSingleUpdate($hash,"webhook_ver",$rev,1); + } + } + Log3 $name,3,"[Shelly_webhook_update] creaing next action index $val, command is $cmd"; + Shelly_HttpRequest($hash,$cmd,$hash->{helper}{actionCreate}[$val],"Shelly_webhook_update","procCreate",$val); # on success, we receive data + return; + }elsif( $comp eq "" ){ + $id = 0; + Log3 $name,4,"[Shelly_webhook_update] $name: check for updating all own webhooks at device"; + }elsif( $comp =~ /\d/ ){ + $id = $comp; + Log3 $name,4,"[Shelly_webhook_update] updating webhook ID=$id for device $name"; + }else{ + Log3 $name,1,"[Shelly_webhook_update] Bad parameter \'$comp\', aborting"; + return "Error"; + } + + my $hooksCount = 0; # number of webhooks on the Shelly + if( $gen == 0 ){ + $hooksCount = ReadingsNum( $name,"webhook_cnt",0 ); + }else{ + $hooksCount = @{$jhash->{'hooks'}}; + } + + if( !defined($hooksCount) ){ + Log3 $name,3,"[Shelly_webhook_update] $name: no webhooks on shelly"; + return; + }else{ + Log3 $name,4,"[Shelly_webhook_update] $name: our counter says $hooksCount webhooks on shelly"; + } + + # current values + # FHEMWEB-device used for webhooks + my $hookdevice = AttrVal($name,"webhook",undef); + if( !defined($hookdevice) ){ + Log3 $name,2,"[Shelly_webhook_update] no FHEMWEB device for webhooks defined"; + return "Please define attr webhook first"; + } + # webname + my $curr_host_webname = AttrVal($hookdevice,"webname","fhem"); + # port + my $curr_host_port = InternalVal($hookdevice,"PORT",undef); + # CSFR-Token + my $curr_token = InternalVal($hookdevice,"CSRFTOKEN",""); + # ip + my $curr_host_ip = qx("\"hostname -I\""); # local + $curr_host_ip =~ m/(\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?).*/; #extract ipv4-address + $curr_host_ip = $1; + + Log3 $name,4,"[Shelly_webhook_update] $name: current values: hookdevice=$hookdevice, ip:port/webname=$curr_host_ip:$curr_host_port/$curr_host_webname token=\'$curr_token\'"; + + # parsing all actions + my ($i,$u); # loop counter + my ($sh_hookid,$sh_hookname,$sh_url,$sh_ip,$sh_port,$sh_webname,$sh_token); # values read from Shelly + + + my $updcmd = ($gen>0?"/rpc/Webhook.Update":"/settings/actions"); + my $ttlChanges=0; # counts total number of changed urls + my $urlChanges=0; # counts number of changed urls of a single event / action + + #get actions + my $msg = "actions on device $name:"; + if( $gen == 0 ){ + # call: /settings/actions + my ($e,$i,$u,$event); + if( $shelly_events{$model}[0] ne "" ){ + foreach my $m ($model,"addon1"){ + # parsing %shelly_events + for( $e=0; $event = $shelly_events{$m}[$e] ; $e++ ){ + for( $i=0; defined($jhash->{actions}{$event}[$i]{index}) ;$i++ ){ + $urlcmd=""; + $urlChanges=0; + for( $u=0; $u<5 ; $u++ ){ # up to 5 possible + $sh_url=$jhash->{actions}{$event}[$i]{urls}[$u]; + ######################### + if( !defined($sh_url) ){ + next; + } + $msg .= "\n".$sh_url; + Log3 $name,4,"[Shelly_webhook_update] $name ($m) ch$i $event: URL$u on shelly is $sh_url"; + if( $sh_url =~ /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/ ){ + $sh_ip = $1; + }else{ + $sh_ip = "non_valid"; + } + if( $sh_url =~ /:(\d{1,4})\/(.*)\?/ ){ + $sh_port = $1; + $sh_webname = $2; + }else{ + $sh_port = 0; + $sh_webname = ""; + } + if( $sh_url =~ m/fwcsrf=(csrf_[a-z0-9]+)/ ){ + $sh_token = $1; + }else{ + $sh_token = ""; + } + Log3 $name,5,"[Shelly_webhook_update:X] ip=$sh_ip port=$sh_port webname=$sh_webname token=$sh_token"; + ######################### + if( $curr_host_ip ne $sh_ip ){ + Log3 $name,5,"[Shelly_webhook_update] ip not matching, skipping"; + $urlcmd .= "&urls[]=$sh_url"; # get this w/o change + }elsif( $curr_host_port==$sh_port + && $curr_host_webname eq $sh_webname + && $curr_token eq $sh_token + && $sh_url !~ /XHR/ ){ + Log3 $name,5,"[Shelly_webhook_update] port/webname and token are matching no XHR, skipping"; + $urlcmd .= "&urls[]=$sh_url"; # get this w/o change + }else{ + # removing XHR + if( $sh_url =~ s/\?XHR=1\&/\?/ ){ + }else{ + $sh_url =~ s/\&XHR=1//; + } + # start changing url + if( $curr_host_port != $sh_port ){ + $sh_url =~ s/:$sh_port\/$sh_webname/:$curr_host_port\/$curr_host_webname/; + Log3 $name,5,"[Shelly_webhook_update] changed port/webname of url: $sh_url"; + } + Log3 $name,5,"[Shelly_webhook_update:T] token=$sh_token"; + if( $curr_token ne "" && $sh_token eq "" ){ + $sh_url .= "&fwcsrf=$curr_token"; + Log3 $name,4,"[Shelly_webhook_update:1a] token added to url: $sh_url"; + }elsif( $curr_token eq "" && $sh_token ne "" ){ + $sh_url =~ s/fwcsrf=csrf_[a-z0-9]+//; + $sh_url =~ s/&&/&/; + $sh_url =~ s/\?&/\?/; + Log3 $name,4,"[Shelly_webhook_update:1r] token removed from url: $sh_url"; + }elsif( $curr_token ne $sh_token ){ + $sh_url =~ s/$sh_token/$curr_token/; + Log3 $name,4,"[Shelly_webhook_update:1c] changed token in url: $sh_url"; + }else{ + Log3 $name,4,"[Shelly_webhook_update] no changes regarding token"; + } + $urlcmd .= "&urls[]=$sh_url"; # %22 = " %22$sh_url%22 + $urlChanges++; + $msg .= "\n$sh_url n \n"; + Log3 $name,2,"[Shelly_webhook_update] $name ($m) ch$i $event: URL$u is now $sh_url"; + } + } + if( $urlChanges > 0 ){ # we have to update this action because at least one url has changed + $urlcmd = "?index=$i&name=$event$urlcmd"; # &enabled=true + Log3 $name,4,"[Shelly_webhook_update] $name ($m) $event ch$i: command[$ttlChanges] is: $urlcmd\n"; + $hash->{helper}{actionUpdate}[$ttlChanges]=$urlcmd; + $ttlChanges++; + }else{ + Log3 $name,4,"[Shelly_webhook_update] $name ($m) channel $i: check of action \'$event\' is OK, nothing to do\n"; #5 + } + } + } + } + } + # Gen2 + }else{ + $ttlChanges = 0; + for( $i=0; defined($jhash->{hooks}[$i]{id}) ;$i++ ){ + $sh_hookid = $jhash->{hooks}[$i]{id}; + # Gen2 only: update only one action, if ID is given with command + if( $id!=0 && $id!=$sh_hookid ){ + Log3 $name,4,"[Shelly_webhook_update] $name: hookid $sh_hookid not selected, skipping update"; + next; + }else{ + Log3 $name,4, "[Shelly_webhook_update] $name: checking action with hookid $sh_hookid"; + } + $sh_hookname = $jhash->{hooks}[$i]{name}; + if( $sh_hookname !~ /^_/ ){ + Log3 $name,4,"[Shelly_webhook_update] hookname $sh_hookname not selected, skipping update"; + next; + } + $urlcmd = ""; + $urlChanges=0; + for( $u=0; $u<5 ; $u++ ){ + $sh_url=$jhash->{hooks}[$i]{urls}[$u]; + ######################### + if( !defined($sh_url) ){ + next; + } + $msg .= "\n$sh_hookid: $sh_url"; + Log3 $name,4,"[Shelly_webhook_update:S] $name ($id) ch$i: URL$u on shelly is $sh_url"; + if( $sh_url =~ /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/ ){ + $sh_ip = $1; + }else{ + $sh_ip = "non_valid"; + } + if( $sh_url =~ /:(\d{1,4})\/(.*)\?/ ){ + $sh_port = $1; + $sh_webname = $2; + }else{ + $sh_port = 0; + $sh_webname = ""; + } + if( $sh_url =~ m/fwcsrf=(csrf_[a-z0-9]+)/ ){ + $sh_token = $1; + }else{ + $sh_token = ""; + } + Log3 $name,5,"[Shelly_webhook_update:S] ip=$sh_ip port=$sh_port webname=$sh_webname token=$sh_token"; + ######################### + if( $curr_host_ip ne $sh_ip ){ + Log3 $name,4,"[Shelly_webhook_update] ip not matching, skipping update"; + #$urlcmd .= "\"$sh_url\","; # get this w/o change + }elsif( $curr_host_port == $sh_port + && $curr_host_webname eq $sh_webname + && $curr_token eq $sh_token + && $sh_url !~ /XHR/ ){ + Log3 $name,4,"[Shelly_webhook_update] port/webname and token are matching, no XHR, skipping update"; + #$urlcmd .= "\"$sh_url\","; # get this w/o change + }else{ + # removing XHR + if( $sh_url =~ s/\?XHR=1\&/\?/ ){ + }else{ + $sh_url =~ s/\&XHR=1//; + } + # start changing url + if( $curr_host_port != $sh_port ){ + $sh_url =~ s/:$sh_port\/$sh_webname/:$curr_host_port\/$curr_host_webname/; + Log3 $name,4,"[Shelly_webhook_update] changed port/webname of url: $sh_url"; + } + Log3 $name,4,"[Shelly_webhook_update:Z] token=$sh_token"; + if( $curr_token ne "" && $sh_token eq "" ){ + $sh_url .= "&fwcsrf=$curr_token"; + Log3 $name,4,"[Shelly_webhook_update:2a] token added to url: $sh_url"; + }elsif( $curr_token eq "" && $sh_token ne "" ){ + $sh_url =~ s/fwcsrf=csrf_[a-z0-9]+//; + $sh_url =~ s/&&/&/; + $sh_url =~ s/\?&/\?/; + Log3 $name,4,"[Shelly_webhook_update:2r] token removed from url: $sh_url"; + }elsif( $curr_token ne $sh_token ){ + $sh_url =~ s/$sh_token/$curr_token/; + Log3 $name,4,"[Shelly_webhook_update:2c] changed token in url: $sh_url"; + }else{ + Log3 $name,4,"[Shelly_webhook_update] no changes regarding token"; + } + #$urlcmd .= "\"$sh_url\","; + $urlChanges++; + $msg .= "\n$sh_hookid: $sh_url n \n"; + Log3 $name,4,"[Shelly_webhook_update] $name ($id) ch$i: URL$u is now $sh_url"; + } + # $urlcmd .= "\"$sh_url\","; + $urlcmd .= "%22$sh_url%22,"; + } + + if( $urlChanges > 0 ){ # we have at least one (of up to 5) url to update + $urlcmd =~ s/&/%26/g; + $urlcmd = "?id=$sh_hookid&urls=[$urlcmd]"; + $urlcmd =~ s/,]/]/; # remove last comma + $urlcmd =~ s/ /%20/g; + if(0){ + $urlcmd =~ s/,/%2C/g; + $urlcmd =~ s/\[/%5B/g; + $urlcmd =~ s/]/%5D/g;} + Log3 $name,4,"[Shelly_webhook_update] $name update command [$ttlChanges] is: $urlcmd"; + $hash->{helper}{actionUpdate}[$ttlChanges]=$urlcmd; + $ttlChanges++; + }else{ + Log3 $name,5,"[Shelly_webhook_update] $name: check of action ID $sh_hookid is OK, nothing to do"; #5 + } + } + } + #Debug $msg; + # FW_directNotify("FILTER=$name","#FHEMWEB:$FW_wname","FW_okDialog( \"$msg\" )", ""); + if( $ttlChanges == 0 ){ + Log3 $name,3,"[Shelly_webhook_update] $name: no actions to update"; + return; + }elsif(1){ + Log3 $name,1,"[Shelly_webhook_update] $name: start updating $ttlChanges actions with command $updcmd"; + Log3 $name,1,"[Shelly_webhook_update] $name: updating action ".$hash->{helper}{actionUpdate}[$ttlChanges-1]." with command $updcmd"; + #start update procedure with the last action + Shelly_HttpRequest($hash,$updcmd,$hash->{helper}{actionUpdate}[$ttlChanges-1],"Shelly_webhook_update","proc",$ttlChanges); # on success, we receive data + } + return; +} # END Shelly_webhook_update() + + +######################################################################################## +# +# Shelly_actionWebhook - Retrieve the url for a webhook +# +# Parameter hash, a =argument array # $cmd: Create, Delete, ... # entity: corresponds to shellies component # channel: shellies channel = 0,1,... @@ -4843,16 +6052,20 @@ if(1){ # first of all, get number of webhooks # returning string like: &urls=["http://129.168.178.100:8083/fhem?cmd=get $name status&fwcsrf=csrf_1234567890"] # &XHR=1 removed from string ######################################################################################## + sub Shelly_actionWebhook ($@) { my ($hash, @a) = @_ ; my $comp = shift @a; # shelly component my $channel = shift @a; my $noe = shift @a; # number of event of component - - my $V = 1; + + my $V = 4; # verbose level my $msg; my $name = $hash->{NAME}; - Log3 $name,$V,"[Shelly_actionWebhook] calling url-builder with args: $name $comp ch:$channel noe:$noe"; + $msg = "calling url-builder with args: $name $comp "; + $msg .= defined($channel)?"ch:$channel ":"no channel "; + $msg .= "noe:$noe"; + Log3 $name,$V,"[Shelly_actionWebhook] $msg"; my $model = AttrVal($name,"model","generic"); my $gen = $shelly_models{$model}[4]; # 0 is Gen1, 1 is Gen2 @@ -4862,10 +6075,10 @@ sub Shelly_actionWebhook ($@) { my $host_ip = qx("\"hostname -I\""); # local $host_ip =~ m/(\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?).*/; #extract ipv4-address $host_ip = $1; - Log3 $name,6,"[Shelly_actionWebhook] the host-ip of $name is: $host_ip"; + Log3 $name,$V,"[Shelly_actionWebhook] the host-ip of $name is: $host_ip"; $webhook .= "http://".$host_ip; - - my $fhemweb = AttrVal($name,"webhook","none"); + + my $fhemweb = AttrVal($name,"webhook","none"); if($fhemweb eq "none"){ $msg = "FHEMweb-device for $name is \'none\' or undefined)"; Log3 $name,$V,"[Shelly_actionWebhook] $msg"; @@ -4879,9 +6092,9 @@ sub Shelly_actionWebhook ($@) { return(undef,"Error: $msg"); } $webhook .= ":".$port; - + my $webname = AttrVal($fhemweb,"webname","fhem"); - Log3 $name,6,"[Shelly_actionWebhook] FHEMweb-device \"$fhemweb\" has port \"$port\" and webname \"$webname\""; + Log3 $name,$V,"[Shelly_actionWebhook] FHEMweb-device \"$fhemweb\" has port \"$port\" and webname \"$webname\""; $webhook .= "\/".$webname; $webhook .= "?cmd="; # set%2520".$name; @@ -4890,26 +6103,16 @@ sub Shelly_actionWebhook ($@) { if( $comp eq "status" || length($shelly_events{$comp}[$noe])==0 ){ $webhook .= "get $name status"; }else{ - $comp = $shelly_events{$comp}[$noe]; - $comp = $fhem_events{$comp}; - $webhook .= "set $name $comp"; + $comp = $shelly_events{$comp}[$noe]; # %shelly_events + $webhook .= "set $name ".$fhem_events{$comp}; # encodings: $ %24 { %7b } %7d - if( $model eq "shellypro3em" ){ - $webhook .= "_%24%7bev.phase%7d "; - } - if( $comp eq "apower" ){ # shellypmmini - $webhook .= "%24%7bev.apower%7d" ; - }elsif( $comp eq "Active_Power" ){ - $webhook .= "%24%7bev.act_power%7d" ; - }elsif( lc($comp) eq "current" ){ - $webhook .= "%24%7bev.current%7d" ; - }elsif( lc($comp) eq "voltage" ){ - $webhook .= "%24%7bev.voltage%7d" ; - }elsif( $comp eq "tempC" ){ - $webhook .= " %24%7bev.tC%7d $channel" ; - }else{ + $webhook =~ s/\$/\%24/g; + $webhook =~ s/\{/\%7b/g; + $webhook =~ s/\}/\%7d/g; + + if( defined($channel) ){ $webhook .= " $channel"; - } + } } $webhook =~ s/\s/\%2520/g; # substitute '&' by '%2520', that will result in '%20' @@ -4921,20 +6124,20 @@ sub Shelly_actionWebhook ($@) { #$webhook .= ($gen>=1?"%22]":""); $webhook .= ($gen>=1?"\"]":""); - + $webhook =~ s/\&/\%26/g; # substitute & by %26 - $webhook = "&".$webhook; + $webhook = "&".$webhook; Log3 $name,$V,"[Shelly_actionWebhook] $name: $webhook"; ########## - return ($webhook);#,undef); -} + return ($webhook); +} # END Shelly_actionWebhook() sub Shelly_rssi { my ($hash, $rssi) = @_; - if( $rssi eq "-" ) { return "-";} + return "-" if( !defined($rssi) || $rssi eq "-" ); my $ret = $rssi; if( $hash->{units} == 1){ $ret .= $si_units{rssi}[1]; if( $rssi < -76 ) { $ret .= " (bad)";} @@ -4947,83 +6150,105 @@ sub Shelly_rssi { } ######################################################################################## -# +# # Shelly_error_handling - handling error from callback functions -# -# Parameter hash, function, error +# +# Parameter: hash, function, error , verbose # ######################################################################################## - sub Shelly_error_handling { - my ($hash, $func, $err, $verbose) = @_; - my $name = $hash->{NAME}; - my ($errN,$errS); - $verbose=1 if( !defined($verbose) ); - my $flag=0; + my ($hash, $func, $err, $verbose) = @_; + my $name = $hash->{NAME}; + my ($errN,$errE,$errS); + $verbose=2 if( !defined($verbose) ); + my $flag=0; if( $hash->{".updateTime"} ){ # is set by 'readingsBeginUpdate()' - $flag=1; + $flag=1; }else{ - readingsBeginUpdate($hash); + readingsBeginUpdate($hash); } - Log3 $name,6,"[$func] device $name has error \"$err\" "; if( $err =~ /timed out/ ){ if( $err =~ /read/ ){ $errN = "Error: Timeout reading"; - }elsif( $err =~ /connect/ ){ - $errN = "Error: Timeout connecting"; + }elsif( $err =~ /connect/ ){ + $errN = "Error: Timeout connecting"; }else{ $errN = "Error: Timeout"; } - readingsBulkUpdateIfChanged($hash,"network",$errN,1); - $errS = "Error: Network"; - }elsif( $err eq "not connected" ){ # from Shelly_proc2G:status + $errS = "Error: Network"; + }elsif( $err =~ /not connected|unreachable/ ){ # from Shelly_proc.G:status $errN = $err; - readingsBulkUpdateIfChanged($hash,"network",$errN,1); $errS = "Error: Network"; #disconnected - }elsif( $err =~ /113/ ){ # keine Route zum Zielrechner (113) + }elsif( $err =~ /113/ ){ # keine Route zum Zielrechner (113) $errN = "not connected (no route)"; - readingsBulkUpdateIfChanged($hash,"network",$errN,1); $errS = "Error: Network"; #disconnected - }elsif( $err =~ /JSON/ ){ + }elsif( $err =~ /gethostbyname.*failed/ ){ $errN = $err; - readingsBulkUpdateIfChanged($hash,"network",$errN,1); - $errS = "Error: JSON"; + $errS = "Error in definition"; + readingsBulkUpdateIfChanged($hash,"network_ip-address","-",1); + }elsif( $err =~ /JSON/ ){ + $errE = $err; + $errS = "Error: JSON"; + }elsif( $err =~ /Auth/ ){ # Shelly is protected by User/Password + $errE = undef; + $errS = "Authentication required"; + }elsif( $err =~ /wrong pct/ ){ + $errE = $err; + $errS = "Error"; }elsif( $err =~ /wrong/ || $err =~ /401/ ){ #401 Unauthorized - $errN = "wrong authentication"; - $errS = "Error: Authentication"; + $errE = $err; + $errS = "Error: Authentication"; + }elsif( $err =~ /404/ ){ #404 No Handler / wrong command + $errE = $err; + $errS = "Error: No Handler"; }else{ - $errN = $err; - $errS = "Error"; + $errE = $err; + $errS = "Error"; } - Log3 $name,$verbose,"[$func] Device $name has Error \'$errN\', state is set to \'$errS\'";# \nfull text=>$err"; - readingsBulkUpdate($hash,"network_disconnects",ReadingsNum($name,"network_disconnects",0)+1) if( ReadingsVal($name,"state","") ne $errS ); + my $intv = InternalVal($name,"INTERVAL",600); + my $msg = "($func) Device $name has Error \'$err\'"; + $msg .= ", state is set to \'$errS\'" if( ReadingsVal($name,"state","-") ne $errS ); + $msg .= " -> increasing interval" if( $errN && $intv < 43200 && $multiplyIntervalOnError > 1 ); + if( $errN ){ + # Network errors + readingsBulkUpdateIfChanged($hash,"network",$errN,1); + readingsBulkUpdateIfChanged($hash,"error","network",1); + readingsBulkUpdate($hash,"network_disconnects",ReadingsNum($name,"network_disconnects",0)+1) if( ReadingsVal($name,"state","") ne $errS ); + if( $multiplyIntervalOnError > 1 && $intv < 43200 ){ + #increase the INTERNAL update interval, but do not exceed 43200sec=12hours + $intv=minNum($multiplyIntervalOnError*$intv,43200); + Shelly_Set($hash,$name,"interval",$intv); # use Shelly_Set() to restart timer! + } + $verbose = 4 if( ReadingsAge($name,"network_disconnects",0) < 3600 ); # try to minimize Log-entries on lower verbose levels + }elsif( $errE ){ + # other errors + readingsBulkUpdateIfChanged($hash,"error",$errE,1); + } + Log3 $name,$verbose,$msg; readingsBulkUpdateMonitored($hash,"state",$errS, 1 ); if( $flag==0 ){ readingsEndUpdate($hash,1); } - return undef; -} +} # END Shelly_error_handling() ######################################################################################## # if unchanged, generates an event and hold the old timestamp -sub -readingsBulkUpdateHoldTimestamp($$$@) +sub readingsBulkUpdateHoldTimestamp($$$@) { my ($hash,$reading,$value,$changed)= @_; my $timestamp=ReadingsTimestamp($hash->{NAME},$reading,undef); # yyyy-MM-dd hh:mm:ss - if( $value eq ReadingsVal($hash->{NAME},$reading,"") ){ + if( $value eq ReadingsVal($hash->{NAME},$reading,"") ){ return readingsBulkUpdate($hash,$reading,$value,$changed,$timestamp); }else{ return readingsBulkUpdate($hash,$reading,$value,$changed); } -} +} # END readingsBulkUpdateHoldTimestamp() # generate events at least at given readings age, even if the reading has not changed -sub -readingsBulkUpdateMonitored($$$@) # derived from fhem.pl readingsBulkUpdateIfChanged() +sub readingsBulkUpdateMonitored($$$@) # derived from fhem.pl readingsBulkUpdateIfChanged() { my ($hash,$reading,$value,$changed)= @_; #$changed=0 if( $changed eq undef ); @@ -5032,31 +6257,24 @@ readingsBulkUpdateMonitored($$$@) # derived from fhem.pl readingsBulkUpdateIfCha Log3 $hash->{NAME},2,$hash->{NAME}.": undefined value for $reading"; return; } - if( ReadingsAge($hash->{NAME},$reading,$MaxAge)>=$MaxAge || $value ne ReadingsVal($hash->{NAME},$reading,"") ){ #|| $changed>=1 -## Log3 $hash->{NAME},6,"$reading: maxAge=$MaxAge ReadingsAge=" -## .ReadingsAge($hash->{NAME},$reading,0)." new value=$value vs old=" -## .ReadingsVal($hash->{NAME},$reading,"") -## # .defined($changed)?"chg=$changed":"undefiniert" -## ; #4 - #$changed=1 if($changed == 2 );#touch - #return + if( ReadingsAge($hash->{NAME},$reading,$MaxAge)>=$MaxAge || $value ne ReadingsVal($hash->{NAME},$reading,"") ){ readingsBulkUpdate($hash,$reading,$value,$changed); }else{ return undef; } -} +} # END readingsBulkUpdateMonitored() -sub -Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChanged() + +sub Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChanged() { my ($hash,$reading,$value,$changed,$timestamp)= @_; my $readingsProfile ="none"; - if($value ne ReadingsVal($hash->{NAME},$reading,"")){ + if($value ne ReadingsVal($hash->{NAME},$reading,"")){ if( !defined($timestamp) ){ # Value of Reading changed: generate Event, timestamp is actual time readingsBulkUpdate($hash,$reading,$value,$changed); - }else{ - # Value of Reading changed: generte Event and set timestamp as calculated by function + }else{ + # Value of Reading changed: generate Event and set timestamp as calculated by function readingsBulkUpdate($hash,$reading,$value,$changed,$timestamp); } }elsif($readingsProfile eq "none" ){ # no change -> do noting, like readingsBulkUpdateIfChanged() @@ -5069,18 +6287,165 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang }elsif($readingsProfile eq "maxAge" ){ # no change -> like above, but only when readings is more than maxAge old my $MaxAge=AttrVal($hash->{NAME},"maxAge",2160000); # default 600h return readingsBulkUpdate($hash,$reading,$value,$changed) if( ReadingsAge($hash->{NAME},$reading,$MaxAge)>=$MaxAge ); - }elsif($readingsProfile eq "hold" ){ # no change -> sent event, but dont change timestamp + }elsif($readingsProfile eq "hold" ){ # no change -> sent event, but dont change timestamp return readingsBulkUpdate($hash,$reading,$value,$changed,ReadingsTimestamp($hash->{NAME},$reading,undef)); }else{ #Error return "Error"; } return undef; -} +} # END Shelly_readingsBulkUpdate() +######################################################################################## # +# Shelly_HttpRequest - processing a non-blocking http call +# +# Parameter: hash, +# cmd eg. "/rpc/Switch.Set" +# urlcmd eg. "?id=0&on=true" +# callback to be called by Shelly_HttpResponse(), eg. "Shelly_response" +# comp additional parameter to process the response, eg. "onoff" +# +# Note: callback function for HttpUtils_NonblockingGet() is always Shelly_HttpResponse() +# +######################################################################################## +sub Shelly_HttpRequest(@){ + my $hash=shift @_; + my $cmd=shift @_; + my $urlcmd=shift @_; + my $function=shift @_; + my $comp=shift @_; # 2G only + my $val =shift @_; + my $name = $hash->{NAME}; + my $creds = Shelly_pwd($hash); + my $tcpip = $hash->{DEF}; # formerly InternalVal($name,"TCPIP",""); + my $model = AttrVal($name,"model","generic"); + my $gen = $shelly_models{$model}[4]; # 0 is Gen1, 1 is Gen2 + my $url_ = "";##($gen>10 ? "/rpc/" : "/"); + $urlcmd = "" if( !defined($urlcmd) ); + $urlcmd =~ s/'/\"/g; + $comp = "" if( !defined($comp) ); + my $param = { + cmd => $cmd, + urlcmd => $urlcmd, + url => "http://".$creds.$tcpip.$url_.$cmd.$urlcmd, + timeout => AttrVal($name,"timeout",4.9), + hash => $hash, + callback => \&Shelly_HttpResponse, + function => \&$function, + comp => $comp, + val => $val, + request => time() + }; + Log3 $name,4,"[Shelly_HttpRequest] issue a non-blocking call to ".$param->{url}.", callback to $function, $comp"; + HttpUtils_NonblockingGet($param); +} # END Shelly_HttpRequest() + +######################################################################################## +# +# Shelly_HttpResponse - processing the answer from a non-blocking http call +# +# Parameter: param, the parameter hash +# err the err-parameter from the call +# data the returned data from the call, will be forwared to the function given by param +######################################################################################## + +sub Shelly_HttpResponse($){ + my ($param,$err,$data) = @_; + my $hash = $param->{hash}; + my $name = $hash->{NAME}; + my $msg=""; + + # write out request time + if( AttrVal($name,'timeout',undef) ){ + my $maxRequest = ReadingsNum($name,$param->{cmd},0); # in milli-seconds + my $currRequest= round(1000*(time()-$param->{request}),3); + $maxRequest = $currRequest if( $currRequest > $maxRequest ); + readingsSingleUpdate($hash,$param->{cmd},"$maxRequest msec | $currRequest msec",1); + } + + if($data eq "null"){ + $data = '{"cover":"successfull"}'; + Log3 $name,5,"[Shelly_HttpResponse] successfull: $name returned \'null\', transfering to JSON: $data"; + delete $hash->{CMD}; + } + if( $param && $err ){ + Shelly_error_handling($hash,"Shelly_HttpResponse:err","$err :: ".$param->{cmd},2); + readingsSingleUpdate($hash,"error",$err,1); + my $val = $param->{code}; + $msg .= "code: $val" if( defined($val) ); + $val = $param->{httpheader}; + $msg .= " header: $val" if( defined($val) ); + $msg .= "\nprotocol: ".$param->{protocol}; + $msg .= " redirects: ".$param->{redirects}; + $msg .= " url: ".$param->{url}; + $msg .= "\npath: ".$param->{path}; + Log3 $name,6,"[Shelly_HttpResponse:err] $msg";#6 + return; + }elsif($data ne ""){ + my $call = $param->{url}; + Log3 $name,5,"[Shelly_HttpResponse] $name $call returned data: $data"; + + # Reset the increasing INTERVAL to default value (attr) + if($multiplyIntervalOnError > 1 && ReadingsVal($name,"state","") =~ /Error/ ){ + Log3 $name,5,"[Shelly_HttpResponse] $name network Error is gone, reset INTERVAL to attributes value"; + Shelly_Set($hash,$name,"interval",-1); + } + + if(ReadingsVal($name,"network","")=~/not connected/){ + readingsSingleUpdate($hash,"network","connected",1); + readingsSingleUpdate($hash,"state","got data",1); + } + # extracting json from data + my $json = JSON->new->utf8; + my $jhash = eval{ $json->decode( $data ) }; + Log3 $name,4,"[Shelly_HttpResponse] $name: standard JSON decoding"; + if( !$jhash ){ ## option 'i' means case-insensitive + if( $data =~ /Not found/i ){ + $msg="error in command: id or component not found"; + }elsif( $data =~ /Device mode is not dimmer/i ){ + $msg="is not a dimmer"; + }elsif( $data =~ /Device mode is not relay/i ){ + $msg="is not in relay mode"; + }elsif( $data =~ /Device mode is not roller/i ){ + $msg="is not in roller mode"; + }elsif( $data =~ /Bad roller_pos/i ){ + $msg="bad roller positon"; + }elsif( $data =~ /Bad timer/i ){ + $msg="bad timer argument"; + }elsif( $data =~ /Precondition failed:(.*)/i ){ + # eg: FAILED_PRECONDITION: Precondition failed: Overvoltage condition present! + $msg=$1; + }elsif( $data =~ /Bad/i ){ # something else gone wrong, eg. bad go + $msg=$data; + }else{ + $msg="invalid JSON data (2): $data"; + $json = JSON->new->utf8->relaxed; + $jhash = eval{ $json->decode( $data ) }; + Log3 $name,4,"[Shelly_HttpResponse] $name: relaxed JSON decoding"; + } + } + if( !$jhash ){ + Shelly_error_handling($hash,"Shelly_HttpResponse:no-hash","$name: $msg",2); + readingsSingleUpdate($hash,"error",$msg,1); + return; + } + + if( $jhash->{code} ){ # we got an error code + my $err = $jhash->{code}; + my $msg = $jhash->{message}; + Shelly_error_handling($hash,"Shelly_HttpResponse:code","$err: $msg",2); + return; + } + Log3 $name,4,"[Shelly_HttpResponse] $name: forwarding JSON-Hash to func: ".Sub::Util::subname($param->{function}); + # calling the sub() forwarded by $param + $param->{function}($param,$jhash); + }else{ + Log3 $name,4,"[Shelly_HttpResponse] ERROR haven't error neither data for $name"; + } +} # END Shelly_HttpResponse() 1; @@ -5097,11 +6462,11 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang

Define

- define <name> Shelly <IP address> + define <name> Shelly <IP address>[:port] [[user:]password]
Defines the Shelly device.

Notes:
  • This module needs the JSON and the HttpUtils package
    • -
  • In Shelly button, switch, roller or dimmer devices one may set URL values that are "hit" when the input or output status changes. +
  • In Shelly button, switch, roller or dimmer devices one may set URL values that are "hit" when the input or output status changes. This is useful to transmit status changes arising from locally pressed buttons directly to FHEM by setting
    • Button switched ON url: http://<FHEM IP address>:<Port>/fhem?cmd=get%20<Devicename>%20status
      • @@ -5114,13 +6479,13 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang http://<FHEM IP address>:<Port>/fhem?cmd=set%20<Devicename>%20button_off%20[<channel>]
    Attention: Of course, a csrfToken must be included as well - or a proper allowed device declared.
    • -
  • The attribute model is set automatically. +
  • The attribute model is set automatically. For shelly devices that are not supported by the device, the attribute is set to generic. If the model attribute is set to generic, the device does not contain any actors, it is just a placeholder for arbitrary sensors
- + -

Set

+

Set

For all Shelly devices
  • @@ -5132,14 +6497,16 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang Note: Empty strings are not accepted, deletion of Shellies name on its website will result in remaining it to the modules name
  • - set <name> config <registername> <value> [<channel>] -
    set the value of a configuration register (Gen1 devices only) + Gen1: set <name> config <registername> <value> [<channel>] +
    set the value of a configuration register (Gen1 devices only) +
    Gen2: set <name> config <command> +
    ap_enable|ap_disable change the access point
  • set <name> interval <integer> -
    Temporarely set the update interval. Will be overwritten by the attribute on restart. - A value of -1 set the interval to the default given by attribute, +
    Temporarely set the update interval. Will be overwritten by the attribute on restart. + A value of -1 set the interval to the default given by attribute, a value of 0 disables the automatic update.
  • @@ -5148,27 +6515,27 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    This is the only way to set the password for the Shelly web interface.
    • For Shelly devices first gen, the attribute 'shellyuser' must be defined - To remove a password, use: + To remove a password, use: set <name> password
  • set <name> reboot -
    Reboot the Shelly +
    Reboot the Shelly
  • - - set <name> reset <counter> -
    Resetting the counters to zero + + set <name> clear <reading> +
    Clearing the reading
  • set <name> update -
    Update the Shelly to the latest stable version +
    Update the Shelly to the latest stable version
-
For Shelly switching devices (model=shelly1|shelly1pm|shellyuni|shelly4|shellypro4pm|shellyplug|shellyem|shelly3em or - (model=shelly2/2.5/plus2/pro2 and mode=relay)) +
For Shelly switching devices (model=shelly1|shelly1pm|shellyuni|shelly4|shellypro4pm|shellyplug|shellyem|shelly3em or + (model=shelly2/2.5/plus2/pro2 and mode=relay))
  • set <name> on|off|toggle [<channel>] @@ -5176,39 +6543,39 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
  • set <name> on-for-timer|off-for-timer <time> [<channel>] -
    switches <channel> on or off for <time> seconds. - Channel numbers are 0 and 1 for model=shelly2/2.5/plus2/pro2 or model=shellyuni, and 0..3 model=shelly4/pro4. - If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
    • +
    switches <channel> on or off for <time> seconds. + Channel numbers are 0 and 1 for model=shelly2/2.5/plus2/pro2 or model=shellyuni, and 0..3 model=shelly4/pro4. + If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
  • set <name> xtrachannels -
    create readingsProxy devices for switching devices with more than one channel
    • - +
    create readingsProxy devices for switching devices with more than one channel +
-
For Shelly roller blind devices (model=shelly2/2.5/plus2/pro2 and mode=roller) +
For Shelly roller blind devices (model=shelly2/2.5/plus2/pro2 and mode=roller)
  • set <name> open|closed|stop [<duration>] -
    drives the roller blind open, closed or to a stop. - The commands open and closed take an optional parameter that determines the drive time in seconds
    • +
    drives the roller blind open, closed or to a stop. + The commands open and closed take an optional parameter that determines the drive time in seconds
  • set <name> pos <integer percent value>
    drives the roller blind to a partially closed position (normally 100=open, 0=closed, see attribute pct100). If the integer percent value - carries a sign + or - the following number will be added to the current value of the position to acquire the target value. -
    + carries a sign + or - the following number will be added to the current value of the position to acquire the target value. +
    set <name> pct <integer percent value> -
    same as set <name> pos <integer percent value> +
    same as set <name> pos <integer percent value>
    • - +
  • set <name> delta +|-<percentage> -
    drives the roller blind a given percentage down or up. - The moving direction depends on the attribute 'pct100'.
    • +
    drives the roller blind a given percentage down or up. + The moving direction depends on the attribute 'pct100'.
  • set <name> zero -
    calibration of roller device
    • -
  • +
    calibration of roller device
    • +
  • set <name> predefAttr
    sets predefined attributes: devStateIcon, cmdIcon, webCmd and eventMap @@ -5216,79 +6583,93 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    Attributes are set only when not defined yet
-
For Shelly dimmer devices model=shellydimmer or (model=shellyrgbw and mode=white) +
For Shelly dimmer devices model=shellydimmer or (model=shellyrgbw and mode=white)
  • set <name> on|off|toggle [<channel>] -
    switches channel <channel> on or off. Channel numbers are 0..3 for model=shellyrgbw. +
    switches channel <channel> on or off. Channel numbers are 0..3 for model=shellyrgbw. If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
  • set <name> on-for-timer|off-for-timer <time> [<channel>] -
    switches <channel> on or off for <time> seconds. Channel numbers 0..3 for model=shellyrgbw. - If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
    • +
    switches <channel> on or off for <time> seconds. Channel numbers 0..3 for model=shellyrgbw. + If the channel parameter is omitted, the module will switch the channel defined in the defchannel attribute.
  • set <name> pct <0..100> [<channel>] -
    percent value to set brightness value. Channel numbers 0..3 for model=shellyrgbw. - If the channel parameter is omitted, the module will dim the channel defined in the defchannel attribute.
    • +
    percent value to set brightness value. Channel numbers 0..3 for model=shellyrgbw. + If the channel parameter is omitted, the module will dim the channel defined in the defchannel attribute.
-
For Shelly RGBW devices (model=shellyrgbw and mode=color) +
For Shelly RGBW devices (model=shellyrgbw and mode=color)
  • set <name> on|off|toggle
    switches device <channel> on or off
  • set <name> on-for-timer|off-for-timer <time> -
    switches device on or off for <time> seconds.
    • +
    switches device on or off for <time> seconds.
  • set <name> hsv <hue value 0..360>,<saturation value 0..1>,<brightness value 0..1> -
    comma separated list of hue, saturation and value to set the color. Note, that 360° is the same hue as 0° = red. - Hue values smaller than 1 will be treated as fraction of the full circle, e.g. 0.5 will give the same hue as 180°.
    • +
    comma separated list of hue, saturation and value to set the color. Note, that 360° is the same hue as 0° = red. + Hue values smaller than 1 will be treated as fraction of the full circle, e.g. 0.5 will give the same hue as 180°.
  • set <name> gain <integer>
    number 0..100 to set the gain of the color channels
    • +
  • + + set <name> effect <Off|0|1|2|3> +
    activies an effect: 1=Meteor Shower 2=Gradual Change 3=Flash
  • set <name> rgb <rrggbb> -
    6-digit hex string to set the color
    • +
    6-digit hex string to set the color
  • set <name> rgbw <rrggbbww> -
    8-digit hex string to set the color and white value
    • +
    8-digit hex string to set the color and white value
  • set <name> white <integer> -
    number 0..100 to set the white value
    • +
    number 0..100 to set the white value

Get

    +
  • + + get <name> actions +
    prints a list of the actions on the screen
  • get <name> config [<registername>] [<channel>] -
    get the value of a configuration register and writes it in reading config. +
    get the value of a configuration register and writes it in reading config. If the register name is omitted, only general data like e.g. the SHELLYID are fetched.
  • get <name> registers -
    displays the names of the configuration registers for this device
    • +
    displays the names of the configuration registers for this device
  • get <name> status -
    returns the current status of the device.
    • +
    returns the current status of the device.
  • get <name> shelly_status -
    returns the current system status of the device.
    • +
    returns the current settings of the device. + Deprecated. Use get .. settings instead + +
  • + + get <name> settings +
    returns the current settings of the device.
  • get <name> model -
    get the type of the Shelly
    • +
    get the type of the Shelly
  • get <name> version -
    display the version of the module
    • +
    display the version of the module

Attributes

@@ -5300,21 +6681,21 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang ShellyName may contain space characters. Note: Empty strings are not accepted, deletion of Shellies name on its website will result in remaining it to the modules name - +
  • attr <name> shellyuser <shellyuser>
    username for addressing the Shelly web interface. Set the password with the set command.
    • - Applicable only for Shellies first gen. + Applicable only for Shellies first gen.
  • attr <name> model <model> -
    type of the Shelly device. If the model attribute is set to generic, the device does not contain any actors, +
    type of the Shelly device. If the model attribute is set to generic, the device does not contain any actors, it is just a placeholder for arbitrary sensors. Note: this attribute is determined automatically.
  • - attr <name> mode relay|roller (only for model=shelly2/2.5/plus2/pro2) + attr <name> mode relay|roller (only for model=shelly2/2.5/plus2/pro2)
    attr <name> mode white|color (only for model=shellyrgbw)
    type of the Shelly device
  • @@ -5322,11 +6703,11 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang attr <name> interval <interval>
    Update interval for reading in seconds. The default is 60 seconds, a value of 0 disables the automatic update.
    -
    Note: The ShellyPro3EM energy meter is working with a set of two intervals: +
    Note: The ShellyPro3EM energy meter is working with a set of two intervals: The power values are read at the main interval (as set by the attribute value), the energy values and calculated power values are read at a multiple of 60 seconds. When setting the main interval, the value is adjusted to match an integer divider of 60. -
    • +
  • attr <name> maxAge <seconds> @@ -5336,13 +6717,13 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
  • attr <name> showinputs show|hide -
    Add the state of the input buttons and their mode to the readings. The default value is show. +
    Add the state of the input buttons and their mode to the readings. The default value is show. Most comfortable when triggered by actions/webhooks from the device.
  • attr <name> showunits none|original|normal|normal2|ISO -
    Add the units to the readings. The default value is none (no units). +
    Add the units to the readings. The default value is none (no units). The energy unit can be selected between Wh, kWh, kJ.
    • none: recommended to get results consistend with ShellyMonitor
      • @@ -5355,33 +6736,33 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • attr <name> maxpower <maxpower> -
      Max power protection in watts. The default value and its range is predetermined by the shelly device. +
      Max power protection in watts. The default value and its range is predetermined by the shelly device.
    • attr <name> timeout <timeout> -
      Timeout in seconds for HttpUtils_NonblockingGet. The default is 4 seconds. - Careful: Use this attribute only if you get timeout errors in your log. +
      Timeout in seconds for HttpUtils_NonblockingGet. The default is 4 seconds. + Careful: Use this attribute only if you get 'connect to ... timed out' errors in your log.
    • attr <name> webhook none|<FHEMWEB-device> (default:none) -
      create a set of webhooks on the shelly device which send a status request to fhem (only 2nd gen devices). +
      create a set of webhooks on the shelly device which send a status request to fhem (only 2nd gen devices).
      If a csrf token is set on the FHEMWEB device, this is taken into account. The tokens are checked regulary and will be updated on the shelly. -
      The names of the webhooks in the shelly device are based on the names of shellies events, - with an preceding and trailing underscore (eg _COVER.STOPPED_). -
      If the attribute is set to none, these webhooks (with a trailing underscore) will be deleted. +
      The names of the webhooks in the shelly device are based on the names of shellies events, + with an preceding and trailing underscore (eg _COVER.STOPPED_). +
      If the attribute is set to none, these webhooks (with a trailing underscore) will be deleted.
      • Webhooks that point to another IP address are ignored by this mechanism. -
      Note: When deleting a fhem device, remove associated webhooks on the Shelly before with attr <name> webhook none or +
      Note: When deleting a fhem device, remove associated webhooks on the Shelly before with attr <name> webhook none or deleteattr <name> webhook
    -
    For Shelly switching devices (mode=relay for model=shelly2/2.5/plus2/pro2, standard for all other switching models) +
    For Shelly switching devices (mode=relay for model=shelly2/2.5/plus2/pro2, standard for all other switching models)
    • attr <name> defchannel <integer> -
      only for multi-channel switches eg model=shelly2|shelly2.5|shelly4 or shellyrgbw in white mode: +
      only for multi-channel switches eg model=shelly2|shelly2.5|shelly4 or shellyrgbw in white mode: Which channel will be switched, if a command is received without channel number
    @@ -5411,76 +6792,77 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
  • attr <name> Energymeter_P <float> -
    calibrate to the suppliers meter-device for meters with backstop functionality +
    calibrate to the suppliers meter-device for meters with backstop functionality or for the purchase meter if two meters or a bidirectional meter are installed -
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours). +
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours).
    Note: the stored attribute value is reduced by the actual value
  • attr <name> Energymeter_R <float>
    calibrate returned energy to the second suppliers meter-device (Bidirectional meters only) -
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours). +
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours).
    Note: the stored attribute value is reduced by the actual value
  • attr <name> Energymeter_F <float>
    calibrate to the suppliers meter-device for Ferraris-type meters -
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours). +
    value(s) added to Shellies value(s) to represent the suppliers meter value(s), in Wh (Watthours).
    Note: the stored attribute value is reduced by the actual value
  • attr <name> EMchannels ABC_|L123_|_ABC|_L123 (default: _ABC) -
    used to attach prefixes or postfixes to the names of the power and energy readings +
    used to attach prefixes or postfixes to the names of the power and energy readings
    Caution: deleting or change of this attribute will remove relevant readings!
  • attr <name> Periods <periodes>
    comma separated list of periodes to calculate energy differences -
    hourQ: a quarter of an hour +
    hourQ: a quarter of an hour +
    hourT: a twelth of an hour (5 minutes)
    dayQ: a quarter of a day -
    dayT: a third of a day (8 hours), starting at 06:00 -
    Caution: when removing an entry from this list or when deleting this attribute, +
    dayT: a third of a day (8 hours), starting at 06:00 +
    Caution: when removing an entry from this list or when deleting this attribute, all relevant readings are deleted!
  • attr <name> PeriodsCorr-F <0.90 ... 1.10>
    a float number as correction factor for the energy differences for the periods given by the attribute "Periods"
    • -
    Standard attributes +
    Standard attributes - - - + + +

    Readings/Generated events

    (selection)
      -
      Webhooks (2nd gen devices only)
      -
    • webhook_cnt +
      Webhooks (2nd gen devices only)
      +
    • webhook_cnt
      number of webhooks stored in the shelly
      • -
    • webhook_ver -
      latest revision number of shellies webhooks
      • +
    • webhook_ver +
      latest revision number of shellies webhooks
      • - -
      ShellyPlus and ShellyPro devices
      - -
    • + +
      ShellyPlus and ShellyPro devices
      + +
    • indicating the configuration of Shellies hardware inputs -
      input_<channel>_mode -
      ShellyPlus/Pro2PM in relay mode: -
      button|switch straight|inverted follow|detached -
      ShellyPlus/Pro2PM in roller mode: -
      button|switch straight|inverted single|dual|detached normal|swapped -
      ShellyPlusI4: -
      button|switch straight|inverted +
      input_<channel>_mode +
      ShellyPlus/Pro2PM in relay mode: +
      button|switch straight|inverted follow|detached +
      ShellyPlus/Pro2PM in roller mode: +
      button|switch straight|inverted single|dual|detached normal|swapped +
      ShellyPlusI4: +
      button|switch straight|inverted
      • button input type: button attached to the Shelly
      • switch input type: switch attached to the Shelly
        • @@ -5493,13 +6875,13 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      • normal the inputs are not swapped *
      • swapped the inputs are swapped *

        • * roller mode only ** relay mode only -
        +
      • - -
    • + +
    • indicating the reason for start or stop of the roller -
      start_reason, stop_reason +
      start_reason, stop_reason
      • button button or switch attached to the Shelly
      • http HTTP/URL eg Fhem
        • @@ -5514,14 +6896,14 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      • overcurrent
      • - - - + + +
      ShellyPlusI4
      - - an input in mode 'button' has usually the state 'unknown'. + + an input in mode 'button' has usually the state 'unknown'. When activated, the input state is set to 'ON' for a short periode, independent from activation time. - The activation time and sequence is reprensented by the readings input_<ch>_action and input_<ch>_actionS, + The activation time and sequence is reprensented by the readings input_<ch>_action and input_<ch>_actionS, which will act simultanously with following values:
      • S single_push
        • @@ -5529,10 +6911,10 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      • SSS triple_push
      • L long_push
      - - NOTE: the readings of an input in mode 'button' cannot actualized by polling. + + NOTE: the readings of an input in mode 'button' cannot actualized by polling. It is necessary to set actions/webhooks on the Shelly! - +

      Webhooks on ShellyPlusI4
      Webhooks generated by Fhem are named as follows: @@ -5541,20 +6923,20 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • _INPUT.TOGGLE_ON_
    • _INPUT.TOGGLE_OFF_
    - +
    Input mode 'button' -
      +
      • _INPUT.BUTTON_PUSH_
      • _INPUT.BUTTON_DOUBLEPUSH_
      • _INPUT.BUTTON_TRIPLEPUSH_
        • -
      • _INPUT.BUTTON_LONGPUSH_
        • +
      • _INPUT.BUTTON_LONGPUSH_
      - - + +
      ShellyPro3EM
      - +
      Power
      - + Power, Voltage, Current and Power-Factor are updated at the main interval, unless otherwise specified
    • Active Power @@ -5571,7 +6953,7 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • Pushed Power
      Active_Power_pushed_<A|B|C|T> -
      float values of the actual power pushed by the Shelly when the value of a phase differs at least 10% to the previous sent value +
      float values of the actual power pushed by the Shelly when the value of a phase differs at least 10% to the previous sent value (update interval depends on load, possible minimum is 1 second) Action on power-events on the Shelly must be enabled.
      • @@ -5580,16 +6962,16 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      Apparent_Power_<A|B|C|T>
      float values of the actual apparent power
    • - Voltage, Current and Power-Factor + Voltage, Current and Power-Factor
      Voltage_<A|B|C>
      Current_<A|B|C|T>
      Power_Factor_<A|B|C>
      float values of the actual voltage, current and power factor
      • Energy
      - + Energy readings are updated each minute, or multiple. -
      When the showunits attribute is set, the associated units (Wh, kWh, kJ) are appended to the values +
      When the showunits attribute is set, the associated units (Wh, kWh, kJ) are appended to the values
    • Active Energy
      Purchased_Energy_<A|B|C|T> @@ -5598,13 +6980,13 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • Total Active Energy
      Total_Energy -
      float value of total purchased energy minus total returned energy +
      float value of total purchased energy minus total returned energy
      A minus sign is indicating returned energy.
      The timestamp of the reading is set to the full minute, as this is Shellies time base. - Day and Week are based on GMT. + Day and Week are based on GMT.
    • - Energymeter + Energymeter
      Total_Energymeter_<F|P|R>
      float values of the purchased (P) or returned (R) energy displayed by the suppliers meter. For Ferraris type meters (F), the returned energy is subtracted from the purchased energy
      • @@ -5614,9 +6996,9 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      float value of energy in a period of time (updated at the defined time interval).
      QDay is a period of 6 hours, starting at 00:00.
      TDay is a period of 8 hours, starting at 06:00. -
      Week is a period of 7 days, starting mondays at 00:00. +
      Week is a period of 7 days, starting mondays at 00:00. - +
    =end html @@ -5630,16 +7012,41 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang

    Define

    - define <name> Shelly <IP address> -
    Definiert das Shelly Device.

    + define <name> Shelly <IP-Adresse|DNS-Name>[:Port] [[Benutzername:]Passwort] +
    Definiert das Shelly Device. + + + + + + + + + + + + + + + + + + + +
    Beispiele
    define meinDevice Shelly 192.168.178.100 mit IP-Adresse
    define meineLampe Shelly 192.168.178.101 fritzi:geheim     mit IP-Adresse, Benutzername und Passwort
    define meinePumpe Shelly ShellyPlusPlugS-44AA55BB66CC mit DNS-Namen
    define meinShelly Shelly 192.168.178.100:11101 mit IP-Adresse des Range-Extender-Devices und Port-Nummer
    +

    + Hinweise:
    • Dieses Modul benötigt die Pakete JSON und HttpUtils
      • - -
    • Das Attribut model wird automatisch gesetzt. + +
    • Das Attribut model wird automatisch gesetzt. Für Shelly Geräte, welche nicht von diesem Modul unterstützt werden, wird das Attribut zu generic gesetzt. Das Device enthält dann keine Aktoren, es ist nur ein Platzhalter für die Bereitstellung von Readings
      • - -
    • Bei bestimmten Shelly Modellen können URLs (Webhooks) festgelegt werden, welche bei Eintreten bestimmter Ereignisse ausgelöst werden. + +
    • Bei bestimmten Shelly Modellen können URLs (Webhooks) festgelegt werden, welche bei Eintreten bestimmter Ereignisse ausgelöst werden. Beispielsweise lauten die Webhooks für die Information über die Betätigung lokaler Eingänge wie folgt:
      • Button switched ON url: @@ -5648,40 +7055,44 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang http://<FHEM IP address>:<Port>/fhem?cmd=set%20<Devicename>%20button_off%20[<channel>]
      Ein Webhook für die Aktualisierung aller Readings lautet beispielsweise: -
        +
        • http://<FHEM IP address>:<Port>/fhem?cmd=get%20<Devicename>%20status
        - -
          -
        • Ein CSRF-Token muss gegebenenfalls in den URL aufgenommen werden oder ein zugehörendes allowed Device muss festgelegt werden.
          • -
        • Die URLs (Webhooks) können mit dem Attribut 'webhook' automatisiert angelegt werden
          • -
        - -
      - + Ein CSRF-Token muss gegebenenfalls in den URL aufgenommen werden oder ein zugehörendes allowed Device muss festgelegt werden.
      + Die URLs (Webhooks) können mit dem Attribut 'webhook' automatisiert angelegt werden +
      • +
    +

    Set

    Für alle Shelly Geräte
      -
    • - - set <name> name <ShellyName> -
      Name des Shelly Gerätes. - Der Shellyname darf Leerzeichen enthalten. -
      • - Hinweis: Leere Zeichenkentten werden nicht akzeptiert. - +
      +
    • Set-Extensions können genutzt werden, allerdings bei Geräten mit mehreren Kanälen + nur für den per defchannel festgelegten Kanal. +
      • +
    • + + set <name> name <ShellyName> +
      Name des Shelly Gerätes. + Der Shellyname darf Leerzeichen enthalten. +
      • + Hinweis: Leere Zeichenkentten werden nicht akzeptiert. +
    • - set <name> config <registername> <value> [<channel>] -
      Setzen eines Registers auf den Wert value (nur für Shellies der 1. Generation) -
      Die verfügbaren Register erhält man mit get <name> registers + Gen1: set <name> config <registername> <value> [<channel>] +
      Setzen eines Registers auf den Wert value (nur für Shellies der 1. Generation) +
      Die verfügbaren Register erhält man mit get <name> registers + +
      Gen2: set <name> config <command> +
      ap_enable|ap_disable aktiviert/deaktiviert den Zugangspunkt (access point)
    • set <name> interval <integer> -
      Vorübergehendes Setzen des Aktualisierungsintervals. Wird bei Restart vom Wert des Attributes interval überschrieben. - Der Wert -1 setzt das Interval auf den Wert des Attributes, +
      Vorübergehendes Setzen des Aktualisierungsintervals. Wird bei Restart vom Wert des Attributes interval überschrieben. + Der Wert -1 setzt das Interval auf den Wert des Attributes, der Wert 0 deaktiviert die automatische Aktualisierung.
    • @@ -5689,71 +7100,107 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang set <name> password <password>
      Setzen des Passwortes für das Shelly Web Interface
      • - Bei Shelly-Geräten der 1. Generation muss zuvor das Attribut 'shellyuser' gesetzt sein. - Ein in Fhem gespeichertes Passwort wird durch Aufruf ohne Parameter entfernt: + Bei Shelly-Geräten der 1. Generation muss zuvor das Attribut 'shellyuser' gesetzt sein. + Ein in Fhem gespeichertes Passwort wird durch Aufruf ohne Parameter entfernt: set <name> password Hinweis: Beim Umbenennen des Devices mit 'rename' geht das Passwort verloren
    • set <name> reboot -
      Neustarten des Shelly +
      Neustarten des Shelly
    • - - set <name> reset <counter> -
      Setzen der Zähler auf Null -
      • + + set <name> clear <reading> +
      Zurücksetzen des/der ausgewählten Readings +
        +
      • disconnects: Reading network_disconnects
        • +
      • error: Reading error
        • +
      • energy: Reading energy (nur bei PMmini Leistungsmessgeräten)
        • +
      • responsetimes: Readings /.... (nur sichtbar, wenn Attribut timeout gesetzt ist)
        • +
      +
    • set <name> update -
      Aktualisieren der Shelly Firmware zur aktuellen stabilen Version +
      Aktualisieren der Shelly Firmware zur aktuellen stabilen Version
    -
    Für Shelly mit Relais (model=shelly1|shelly1pm|shellyuni|shelly4|shellypro4pm|shellyplug|shellyem|shelly3em oder - (model=shelly2/2.5/plus2/pro2 und mode=relay)) +
    Für Shelly mit Relais (model=shelly1|shelly1pm|shellyuni|shelly4|shellypro4pm|shellyplug|shellyem|shelly3em oder + (model=shelly2/2.5/plus2/pro2 und mode=relay)) sowie Dimmer, RGBW und Leuchten
    • + + + set <name> ON|OFF +
      schaltet ALLE Kanäle eines mehrkanaligen Gerätes ein bzw. aus.
      • +
    • + + + set <name> on|off|toggle [<channel>] -
      schaltet den Kanal <channel> on oder off. Die Kanalnummern sind 0 und 1 für model=shelly2/2.5/plus2/pro2, 0..3 für model=shelly4. - Wenn keine Kanalnummer angegeben, wird der mit dem Attribut 'defchannel' definierte Kanal geschaltet.
      • +
      schaltet den Kanal <channel> ein bzw. aus. Bei Geräten mit nur einem Kanal kann die Angabe des Kanals entfallen. + Wenn bei mehrkanaligen Geräte keine Kanalnummer angegeben wird, wird der mit dem Attribut 'defchannel' definierte Kanal geschaltet.
    • + + set <name> on-for-timer|off-for-timer <time> [<channel>] -
      schaltet den Kanal <channel> on oder off für <time> Sekunden. - Kanalnummern sind 0 und 1 für model=shelly2/2.5/plus2/pro2 oder model=shellyuni, und 0..3 model=shelly4/pro4. - Wird keine Kanalnummer angegeben, wird der mit dem Attribut 'defchannel' definierte Kanal geschaltet.
      • +
      schaltet den Kanal <channel> für <time> Sekunden ein bzw. aus. + Wenn bei mehrkanaligen Geräte keine Kanalnummer angegeben wird, wird der mit dem Attribut 'defchannel' definierte Kanal geschaltet. +
        + Hinweise: +
      • Im Shelly aktivierte Timer 'auto_on' und 'auto_off' bleiben unberücksichtig.
        • +
      • Bei nachfolgenden Befehlen, z.B. 'set ... pct ...' bleiben gestartete 'on-for-timer' Timer bestehen
        • +
      + +
    • + + set <name> intervals <from1>-<till1> <from2>-<till2> ... +
      Das Gerät wird für die spezifizierten Intervalle eingeschaltet. + Bei mehrkanaligen Geräten wird der mit defchannel definierte Kanal geschaltet. + Die einzelnen Intervalle sind Leerzeichen getrennt, und ein Intervall besteht aus zwei Zeitspezifikationen, + die mit einem "-" getrennt sind.
      • + +
    • + set <name> xtrachannels -
      Erstellen von readingsProxy Devices für Shellies mit mehr als einem Relais
      • - +
      Erstellen von readingsProxy Devices für Shellies mit mehr als einem Kanal +
    -
    Für Shelly Rollladenaktoren (model=shelly2/2.5/plus2/pro2 und mode=roller) +
    Für Shelly Rollladenaktoren (model=shelly2/2.5/plus2/pro2 und mode=roller)
      -
    • +
    • + + set <name> open|closed [<duration>] -
      Fährt den Rollladen aufwärts zur Position offen (open) bzw. abwärts zur Position geschlossen (closed). +
      Fährt den Rollladen aufwärts zur Position offen (open) bzw. abwärts zur Position geschlossen (closed). Es kann ein optionaler Parameter für die Fahrzeit in Sekunden mit übergeben werden -
      • - -
    • +
      • + +
    • + set <name> stop
      Beendet die Fahrbewegung (stop).
      • - -
    • + +
    • + set <name> pos <integer percent value> -
      Fährt den Rollladen zu einer Zwischenstellung (normalerweise gilt 100=offen, 0=geschlossen, siehe Attribut 'pct100'). - Wenn dem Wert für die Zwischenstellung ein Plus (+) oder Minus (-) - Zeichen vorangestellt wird, +
      Fährt den Rollladen zu einer Zwischenstellung (normalerweise gilt 100=offen, 0=geschlossen, siehe Attribut 'pct100'). + Wenn dem Wert für die Zwischenstellung ein Plus (+) oder Minus (-) - Zeichen vorangestellt wird, wird der Wert auf den aktuellen Positionswert hinzugezählt.
      - - äquivalent zu set <name> pct <integer percent value> + + äquivalent zu set <name> pct <integer percent value>
      • -
    • +
    • + set <name> delta +|-<percentage> -
      Fährt den Rollladen einen gegebenen Prozentwert auf oder ab. +
      Fährt den Rollladen einen gegebenen Prozentwert auf oder ab. Die Fahrtrichtung ist abhängig vom Attribut 'pct100'.
    • @@ -5770,50 +7217,69 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      Für Shelly Dimmer Devices (model=shellydimmer oder model=shellyrgbw und mode=white)
      • - set <name> on|off|toggle [<channel>] + set <name> on|off|toggle [<channel>]
        schaltet Kanal <channel> on oder off.
      • - - set <name> blink <count> <time> [<channel>] + + set <name> blink <count> <time> [<channel>]
        schaltet Kanal <channel> entsprechend Anzahl 'count' für Zeit 'time' ein und aus.
      • set <name> on-for-timer|off-for-timer <time> [<channel>]
        schaltet Kanal <channel> on oder off für <time> Sekunden.
        • - -
      • + +
      • + set <name> pct <1...100> [<channel>]
        Prozentualer Wert für die Helligkeit (brightness). Es wird nur der Helligkeitswert gesetzt ohne das Gerät ein oder aus zu schalten. -
        • - -
      • - set <name> dim <0...100> [<channel>] -
        Prozentualer Wert für die Helligkeit (brightness). Es wird nur der Helligkeitswert gesetzt und eingeschaltet. - Bei einem Helligkeitswert gleich 0 (Null) wird ausgeschaltet, der im Shelly gespeicherte Helligkeitswert bleibt unverändert. -
        • - -
      • - set <name> dimup [<1...100>] [<channel>] -
        Prozentualer Wert für die Vergrößerung der Helligkeit. - Ist kein Wert angegeben, wird das Attribut dimstep ausgewertet. - Der größte erreichbare Helligkeitswert ist 100. - Ist das Gerät aus, ergibt sich der neue Helligkeitswert aus dem angegebenen Wert und das Gerät wird eingeschaltet. +
        • +
      • set <name> pct 0 [<channel>] +
        Das Gerät/Kanal wird ausgeschaltet, der vorhandene Helligkeitswert bleibt unverändert. +
        • + +
      • + + set <name> dim <0...100>[:<transition>] [<channel>] +
        Prozentualer Wert für die Helligkeit (brightness). Es wird der Helligkeitswert gesetzt und eingeschaltet. + Bei einem Helligkeitswert gleich 0 (Null) wird ausgeschaltet, der im Shelly gespeicherte Helligkeitswert bleibt unverändert. + Optional kann mit Doppelpunkt getrennt die Transit-Zeit 'transition' in Sekunden vorgegen werden. +
        • + +
      • + + set <name> dimup [<1...100>][:<transition>] [<channel>] +
        Prozentualer Wert für die Vergrößerung der Helligkeit. + Ist kein Wert angegeben, wird das Attribut dimstep ausgewertet. + Der größte erreichbare Helligkeitswert ist 100. + Ist das Gerät aus, ergibt sich der neue Helligkeitswert aus dem angegebenen Wert und das Gerät wird eingeschaltet. + Optional kann mit Doppelpunkt die Transit-Zeit 'transition' in Sekunden vorgegen werden. +
        • + +
      • + + set <name> dimdown [<1...100>][:<transition>] [<channel>] +
        Prozentualer Wert für die Verringerung der Helligkeit. + Ist kein Wert angegeben, wird das Attribut dimstep ausgewertet. + Der kleinste erreichbare Helligkeitswert ist der im Shelly gespeicherte Wert für "minimum brightness". + Optional kann mit Doppelpunkt die Transit-Zeit 'transition' in Sekunden vorgegen werden. +
        • + +
      • + + set <name> dim-for-timer <brightness>[:<transition>] <time> [<channel>] +
        Wie on-for-timer mit zusätzlicher Angabe eines prozentualen Wertes 'brightness' für die Helligkeit. + Nach Ablauf der Zeit 'time' wird ausgeschaltet. + Optional kann mit Doppelpunkt die Transit-Zeit 'transition' in Sekunden vorgegen werden.
        • -
      • - set <name> dimdown [<1...100>] [<channel>] -
        Prozentualer Wert für die Verringerung der Helligkeit. - Ist kein Wert angegeben, wird das Attribut dimstep ausgewertet. - Der kleinste erreichbare Helligkeitswert ist der im Shelly gespeicherte Wert für "minimum brightness". -
        • - -
      • - set <name> dim-for-timer <brightness> <time> [<channel>] -
        Prozentualer Wert für die Helligkeit. Nach Ablauf der Zeit 'time' wird ausgeschaltet. -
      +
      + Hinweis zu transition: Nur bei Gen2-Dimmern verfügbar. + Ist das Gerät eingeschaltet 'on', dann beginnt der Dimmvorgang beim aktuellen Helligkeitswert. + Bei ausgeschaltetem Gerät beginnt der Dimmvorgang bei 0. +
      Hinweis für ShellyRGBW (white-Mode): Kanalnummern sind 0..3. Wird keine Kanalnummer angegeben, wird der mit dem Attribut 'defchannel' definierte Kanal geschaltet. -
      +

      Für Shelly RGBW Devices (model=shellyrgbw und mode=color)
      • @@ -5821,17 +7287,23 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        schaltet das Device <channel> on oder off
      • set <name> on-for-timer|off-for-timer <time> -
        schaltet das Device für <time> Sekunden on oder off.
        • +
        schaltet das Device für <time> Sekunden on oder off.
      • set <name> hsv <hue value 0..360>,<saturation value 0..1>,<brightness value 0..1> -
        Komma separierte Liste von Farbton (hue), Sättigung (saturation) und Helligkeit zum Setzen der Lichtfarbe. - Hinweis: ein Hue-Wert von 360° entspricht einem Hue-Wert von 0° = rot. +
        Komma separierte Liste von Farbton (hue), Sättigung (saturation) und Helligkeit zum Setzen der Lichtfarbe. + Hinweis: ein Hue-Wert von 360° entspricht einem Hue-Wert von 0° = rot. Hue-Werte kleiner als 1 werden als Prozentwert von 360° gewertet, z.B. entspricht ein Hue-Wert von 0.5 einem Hue-Wert von 180°.
      • set <name> gain <integer> -
        setzt die Verstärkung (Helligkeit) der Farbkanäle aufen einen Wert 0..100
        • +
        setzt die Verstärkung (Helligkeit) der Farbkanäle auf einen Wert 0..100 +
      • + + set <name> effect <Off|0|1|2|3> +
        aktiviert einen Effekt (nur Farbkanäle): 1=Meteor Shower Farbwechsel 2=Gradual Change Farbwechsel 3=Flash Blitz
        • + 1 ws bl vt rt ge gn ge + 2 gn bl vt rt ge
      • set <name> rgb <rrggbb> @@ -5844,14 +7316,102 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang set <name> white <integer>
        setzt den Weiß-Wert auf einen Wert 0..100
        • -
      +
    + +
    Für Shelly Bulb duo: +
      +
    • + + set <name> ct <integer> +
      setzt die Farbtemperatur auf einen Wert 3000...6500 K
      • +
    + +
    Für Shellies Gen2: +
      +
    • + + set <name> actions create|delete|disable|enable|update <...> +
      +
      set <name> actions create info|<index>|all   + Erstellen von Actions auf dem Shelly +
      set <name> actions delete <id>|own|all       + Löschen von Actions auf dem Shelly +
      set <name> actions disable <id>       + Deaktivieren einer Action auf dem Shelly +
      set <name> actions enable <id>        + Deaktivieren einer Action auf dem Shelly +
      set <name> actions update [<id>]      + Aktualisieren aller/einer Action(s) auf dem Shelly +
      • + +
    • create info: + Gibt eine Liste der verfügbaren Actions aus. Mit dem in der ersten Spalte aufgeführtem Index kann eine einzelne Action angelegt werden.
      • +
    • create <index>: + Legte eine Action für das unter <index> angegebene Event auf dem Shelly an.
      • +
    • create all: + Legt alle verfügbaren Actions mit an FHEM addressierten Webhooks auf dem Shelly an, + so dass der Shelly von sich aus Statusänderungen an FHEM sendet. + Voraussetzung ist, dass eine FHEMWEB-Instanz für das Ziel der Webhooks mittels des Attributes webhook definiert ist. +
      Hinweise: +
      Dezeit nur für Shellies der 2.Gen. verfügbar, Actions auf den Shellies der 1. Gen. müssen manuell angelegt werden. +
      Enthält das zugehörige FHEMWEB Device ein CSFR-Token, wird dies mit berücksichtigt. +
      Die Namen der Actions auf dem Shelly werden entsprechend der zugehörigen Events benannt, + zusätzlich mit einem vorangestellten und angehangenen Unterstrich (z.B. _COVER.STOPPED_).
      • +
    • delete id: + Die Action mit der ID <id> wird vom Shelly entfernt.
      • +
    • delete own: + Automatisch erstellte Actions zur eigenen FHEMWEB-Instanz (mit Unterstrich) auf dem Shelly werden entfernt.
      • +
    • delete all: + Alle actions auf dem Shelly werden entfernt.
      • +
    • disable id: + Die Action mit der ID <id> wird auf dem Shelly deaktiviert.
      • +
    • enable id: + Die Action mit der ID <id> wird auf dem Shelly aktiviert.
      • +
    • update: + Die automatisch erstellten 'eigenen' Actions auf dem Shelly werden aktualisiert. + Token werden vom Modul geprüft und die Webhooks auf dem Shelly werden gegenenfalls aktualisiert.
      • +
    • update id: + Wie 'update' jedoch wird nur die Action mit der ID <id> aktualisiert.
      • + Actions mit bis zu fünf Webhooks werden unterstützt. + Webhooks, welche nicht an FHEM addressiert sind, werden von diesem Mechanismus nicht verändert. +
    + + + +
    Für Shelly Devices mit Eingängen (model=...) +
      +
    • + set <name> input mode [channel] +
      ändert den Modus des Einganges [channel] zu <mode>
      • +
    + +
    Für ShellyPro3EM (model=...) +
      +
    • + set <name> interval_power <integer> +
      setzt das Aktualisierungsintervall der Power-Readings zu <integer> Sekunden +
      Standardwert ist das allgemeine Intervall. +
      • +
    + +
    +
    Hinweise: +
    Vor dem Löschen eines FHEM-Devices sollten die zugehörigen Actions auf dem Shelly entfernt werden. +
    Alle mit dem Shelly-Modul durchführbaren Operationen können natürlich auch manuell über das GUI des Shelly durchgeführt werden. + +

    Get

      +
    • + + get <name> actions +
      Erstellt eine Liste aller auf dem Shelly vorhandenen Actions +
    • get <name> config [<registername>] [<channel>] -
      Holt den Inhalt eines Konfigurationsregisters vom Shelly und schreibt das Ergebnis in das Reading 'config'. +
      Holt den Inhalt eines Konfigurationsregisters vom Shelly und schreibt das Ergebnis in das Reading 'config'. Wird kein Registername angegeben, werden nur allgemeine Daten wie z.B. die SHELLYID abgelegt.
    • @@ -5864,7 +7424,17 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • get <name> shelly_status -
      Aktualisiert die Systemdaten des Shelly.
      • +
      Aktualisiert die Systemdaten des Shelly. + Veraltet/abgekündigt: stattdessen get ... settings + +
    • + + get <name> settings +
      Aktualisiert die Systemdaten des Shelly.
      • +
    • + + get <name> actions +
      Zeigt die im Shelly hinterlegten Actions/Webhooks an.
    • get <name> model @@ -5874,18 +7444,20 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang get <name> version
      Zeigt die Version des FHEM-Moduls an
    + + -

    Attributes

    +

    Attribute

    • attr <name> name <ShellyName> -
      Name des Shelly Devices. - Wenn kein Name für den Shelly vergeben wurde oder wenn der Name auf der Website des Shelly gelöscht wird, +
      Name des Shelly Devices. + Wenn kein Name für den Shelly vergeben wurde oder wenn der Name auf der Website des Shelly gelöscht wird, wird der Shelly-Name entsprechend dem Namens des FHEM-Devices gesetzt. Der Shelly-Name darf Leerzeichen enthalten, leere Zeichenketten werden nicht akzeptiert.
      • - +
    • attr <name> shellyuser <shellyuser> @@ -5893,54 +7465,60 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang Das Passwort wird mit dem 'set ... password'-Befehl gesetzt.
      • Bei den Shellies der 2. Gen ist shellyuser=admin fest vorgegeben und kann nicht geändert werden. - +
    • attr <name> model <model> -
      Type des Shelly Device. Wenn das Attribut model zu generic gesetzt wird, enthält das Device keine Aktoren, +
      Type des Shelly Device. Wenn das Attribut model zu generic gesetzt wird, enthält das Device keine Aktoren, es ist dann nur ein Platzhalter für Readings. Hinweis: Dieses Attribut wird bei Definition automatisch ermittelt.
    • - attr <name> mode relay|roller (nur bei model=shelly2/2.5/plus2/pro2) + attr <name> mode relay|roller (nur bei model=shelly2/2.5/plus2/pro2)
      attr <name> mode white|color (nur bei model=shellyrgbw)
      Betriebsart bei bestimmten Shelly Devices
    • attr <name> interval <interval> -
      Aktualisierungsinterval für das Polling der Daten vom Shelly. +
      Aktualisierungsinterval für das Polling der Daten vom Shelly. Der Default-Wert ist 60 Sekunden, ein Wert von 0 deaktiviert das automatische Polling. -
      -
      Hinweis: Bei den ShellyPro3EM Energiemessgeräten erfolgt das Polling mit zwei verschiedenen Intervallen: - Die Leistungswerte werden entsprechend dem Attribut 'interval' gelesen, - die Energiewerte (und daraus rekursiv bestimmte Leistungswerte) werden alle 60 Sekunden oder einem Vielfachen davon gelesen. - Beim Setzen des Attributes 'interval' wird der Wert so angepasst, - dass das Intervall entweder ein ganzzahliger Teiler oder ein Vielfaches von 60 ist. +
      • +
    • + + attr <name> interval_power <interval> +
      Aktualisierungsinterval für das Polling der Leistungswerte von ShellyPro3EM Energiemessgeräten (i.W. Strom, Spannung, Leistung). + Der Default-Wert ist das mit dem Attribut interval festgelegte Intervall. Minimalwert ist 1 sec. +
      • +
      Hinweise: +
      Wenn interval_power gesetzt ist, kann interval auf einen größeren Wert (z.B. 300 sec) gesetzt werden. +
      Bei den ShellyPro3EM Energiemessgeräten werden die Energiewerte (und daraus rekursiv bestimmte Leistungswerte) + alle 60 Sekunden oder einem Vielfachen davon gelesen. +
    • attr <name> maxAge <seconds> -
      Mit diesem Attribut kann bei einigen Readings die Auslösung eines Events bei Aktualisierung des Readings erzwungen werden, - auch wenn sich das Reading nicht geändert hat. +
      Mit diesem Attribut kann bei einigen Readings die Auslösung eines Events bei Aktualisierung des Readings erzwungen werden, + auch wenn sich das Reading nicht geändert hat. Der Standardwert ist 2160000 Sekunden = 600 Stunden, Minimalwert ist das Pollingintervall.
    • attr <name> showinputs show|hide -
      Das Attribut steuert die Berücksichtigung von Eingangssignalen an den Schalteingängen 'input' des Shelly. +
      Das Attribut steuert die Berücksichtigung von Eingangssignalen an den Schalteingängen 'input' des Shelly. Der Status und die Betriebsart des Eingangs/der Eingänge werden als Reading dargestellt. - In der Standardeinstellung werden die Readings angezeigt ('show'). + In der Standardeinstellung werden die Readings angezeigt ('show'). Dies ist besonders dann sinnvoll, wenn die Informationen zu den Eingängen vom Shelly via 'Shelly actions' (webhooks) vom Shelly gepusht werden.
    • attr <name> showunits none|original|normal|normal2|ISO -
      Anzeige der Einheiten in den Readings. Der Standardwert ist 'none' (keine Einheiten anzeigen). +
      Anzeige der Einheiten in den Readings. Der Standardwert ist 'none' (keine Einheiten anzeigen). Die Einheit für Energie können zwischen Wh, kWh und kJ gewählt werden.
      • none: empfohlen im Zusammenhang mit ShellyMonitor
        • -
      • original: Einheiten werden entsprechend dem Shelly-Device angezeigt +
      • original: Einheiten werden entsprechend dem Shelly-Device angezeigt (z.B. Wm (Wattminuten) für die meisten Devices der 1. Gen.)
      • normal: Energie wird als Wh (Wattstunde) ausgegeben
      • normal2: Energie wird als kWh (Kilowattstunde) ausgegeben
        • @@ -5950,37 +7528,29 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
      • attr <name> maxpower <maxpower> -
        Leistungswert für den Überlastungsschutz des Shelly in Watt. - Der Standardwert und der Einstellbereich wird vom Shelly-Device vorgegeben. +
        Leistungswert für den Überlastungsschutz des Shelly in Watt. + Der Standardwert und der Einstellbereich wird vom Shelly-Device vorgegeben.
      • attr <name> timeout <timeout> -
        Zeitlimit für nichtblockierende Anfragen an den Shelly. Der Standardwert ist 4 Sekunden. - Achtung: Dieses Attribut sollte nur bei Timingproblemen ('timeout errors' in der Logdatei) verändert werden. +
        Zeitlimit für nichtblockierende Anfragen an den Shelly. Der Standardwert ist 4 Sekunden. + Dieses Attribut sollte bei Timingproblemen ('connect to ... timed out' in der Logdatei) angepasst werden. +
        Durch das Setzen dieses Attributs werden für die diversen Anfragen an den Shelly Readings mit Angaben der Reaktionszeit geschrieben. + Diese Readings werden durch Löschen des Attributes entfernt.
      • - attr <name> webhook none|<FHEMWEB-device> (default:none) -
        Legt einen oder mehrere Actions mit an FHEM addressierten Webhooks auf dem Shelly an, - so dass der Shelly von sich aus Statusänderungen an FHEM sendet. - Hinweis: Dezeit nur für Shellies der 2.Gen. verfügbar, Actions auf den Shellies der 1. Gen. müssen manuell angelegt werden. -
        Enthält das zugehörige FHEMWEB Device ein CSFR-Token, wird dies mit berücksichtigt. - Token werden vom Modul geprüft und die Webhooks auf dem Shelly werden gegenenfalls aktualisiert. -
        Die Namen der Actions auf dem Shelly werden entsprechend der zugehörigen Events benannt, - zusätzlich mit einem vorangestellten und angehangenen Unterstrich (z.B. _COVER.STOPPED_). -
        Wird das Attribut zu 'none' gesetzt, werden diese Actions (mit Unterstrich) auf dem Shelly entfernt. -
        • - Webhooks, welche nicht an FHEM addressiert sind, werden von diesem Mechanismus ignoriert. -
        Hinweis: Vor dem Löschen eine FHEM-Devices sollten die zugehörigen Actions auf dem Shelly mit attr <name> webhook none oder - deleteattr <name> webhook entfernt werden. + attr <name> webhook <FHEMWEB-device> +
        Auswahl der FHEMWEB-Instanz, für welche die Webhooks generiert werden (siehe set <name> actions create) +
      -
      Für Shelly Relais Devices (mode=relay für model=shelly2/2.5/plus2/pro2, Standard für alle anderen Relais Modelle) +
      Für Shelly Relais Devices (mode=relay für model=shelly2/2.5/plus2/pro2, Standard für alle anderen Relais Modelle)
      • attr <name> defchannel <integer> -
        nur für mehrkanalige Relais Modelle (z.B. model=shelly2|shelly2.5|shelly4) oder ShellyRGBW im 'white mode': +
        nur für mehrkanalige Relais Modelle (z.B. model=shelly2|shelly2.5|shelly4) oder ShellyRGBW im 'white mode': Festlegen des zu schaltenden Kanals, wenn ein Befehl ohne Angabe einer Kanalnummer empfangen wird.
      @@ -5989,7 +7559,7 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    • attr <name> dimstep <integer> -
      nur für dimmbare Modelle (z.B. model=shellydimmer) oder ShellyRGBW im 'white mode': +
      nur für dimmbare Modelle (z.B. model=shellydimmer) oder ShellyRGBW im 'white mode': Festlegen der Schrittweite der Befehle dimup / dimdown. Default ist 25.
    @@ -6019,40 +7589,41 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
  • attr <name> Energymeter_P <float> -
    Anpassen des Zählerstandes an den Zähler des Netzbetreibers, für Zähler mit Rücklaufsperre bzw. für den Bezugszähler, in Wh (Wattstunden). +
    Anpassen des Zählerstandes an den Zähler des Netzbetreibers, für Zähler mit Rücklaufsperre bzw. für den Bezugszähler, in Wh (Wattstunden).
    Hinweis: Beim Anlegen des Attributes wird der Wert um den aktuellen Zählerstand reduziert
  • attr <name> Energymeter_R <float> -
    Anpassen des Zählerstandes an den Einspeisezähler des Netzbetreibers (Bidirectional meters only), in Wh (Wattstunden). +
    Anpassen des Zählerstandes an den Einspeisezähler des Netzbetreibers (Bidirectional meters only), in Wh (Wattstunden).
    Hinweis: Beim Anlegen des Attributes wird der Wert um den aktuellen Zählerstand reduziert
  • attr <name> Energymeter_F <float> -
    Anpassen des Zählerstandes an den Zähler des Netzbetreibers, für Zähler ohne Rücklaufsperre (Ferraris-Zähler), in Wh (Wattstunden). +
    Anpassen des Zählerstandes an den Zähler des Netzbetreibers, für Zähler ohne Rücklaufsperre (Ferraris-Zähler), in Wh (Wattstunden).
    Hinweis: Beim Anlegen des Attributes wird der Wert um den aktuellen Zählerstand reduziert
  • attr <name> EMchannels ABC_|L123_|_ABC|_L123 (default: _ABC) -
    Festlegung der Readingnamen mit Postfix oder Präfix +
    Festlegung der Readingnamen mit Postfix oder Präfix
    Achtung: Das Löschen oder Ändern dieses Attributes führt zum Löschen der zugehörigen Readings!
  • attr <name> Balancing [0|1] -
    Saldierung des Gesamtenergiedurchsatzes aktivieren/deaktivieren. Das Intervall darf nicht größer als 20 sec sein. -
    Achtung: +
    Saldierung des Gesamtenergiedurchsatzes aktivieren/deaktivieren. Das Intervall-Attribut darf nicht größer als 20 sec sein. +
    Achtung: Das Deaktivieren des Attributes führt zum Löschen aller zugehörigen Readings _T!
  • attr <name> Periods <periodes> -
    Komma getrennte Liste von Zeitspannen für die Berechnung von Energiedifferenzen (Energieverbrauch) +
    Komma getrennte Liste von Zeitspannen für die Berechnung von Energiedifferenzen (Energieverbrauch)
    min: Minute +
    hourT: Zwölftelstunde (5 Minuten)
    hourQ: Viertelstunde (15 Minuten) -
    hour: Stunde -
    dayQ: Tagesviertel (6 Stunden) +
    hour: Stunde +
    dayQ: Tagesviertel (6 Stunden)
    dayT: Tagesdrittel (8 Stunden) beginnend um 06:00
    Week: Woche -
    Achtung: +
    Achtung: Das Entfernen eines Eintrages dieser Liste oder Löschen des Attributes führt zum Löschen aller zugehörigen Readings!
  • @@ -6060,14 +7631,14 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
    Korrekturfaktor für die berechneten Energiedifferenzen in den durch das Attribut 'Periods' gewählten Zeitspannen
    • -
    Standard Attribute +
    Standard Attribute
      -
    • alias, - comment, - event-on-update-reading, - event-on-change-reading, - room, - eventMap, +
    • alias, + comment, + event-on-update-reading, + event-on-change-reading, + room, + eventMap, verbose, webCmd
      • @@ -6076,24 +7647,24 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang

      Readings und erzeugte Events (Auswahl)

        -
        Webhooks (2nd gen devices only)
        -
      • webhook_cnt +
        Webhooks (2nd gen devices only)
        +
      • webhook_cnt
        number of webhooks stored in the shelly,
        • -
      • webhook_ver +
      • webhook_ver
        latest revision number of shellies webhooks.
        • - -
        ShellyPlus and ShellyPro devices
        - -
      • + +
        ShellyPlus and ShellyPro devices
        + +
      • indicating the configuration of Shellies hardware inputs -
        input_<channel>_mode -
        ShellyPlus/Pro2PM in relay mode: -
        button|switch straight|inverted follow|detached -
        ShellyPlus/Pro2PM in roller mode: -
        button|switch straight|inverted single|dual|detached normal|swapped -
        ShellyPlusI4: -
        button|switch straight|inverted +
        input_<channel>_mode +
        ShellyPlus/Pro2PM in relay mode: +
        button|switch straight|inverted follow|detached +
        ShellyPlus/Pro2PM in roller mode: +
        button|switch straight|inverted single|dual|detached normal|swapped +
        ShellyPlusI4: +
        button|switch straight|inverted
        • button input type: button attached to the Shelly
        • switch input type: switch attached to the Shelly
          • @@ -6109,10 +7680,10 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang

        • - -
      • + +
      • indicating the reason for start or stop of the roller -
        start_reason, stop_reason +
        start_reason, stop_reason
        • button button or switch attached to the Shelly
        • http HTTP/URL eg Fhem
          • @@ -6127,14 +7698,14 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        • overcurrent
        • - - - + + +
        ShellyPlusI4
        - - an input in mode 'button' has usually the state 'unknown'. + + an input in mode 'button' has usually the state 'unknown'. When activated, the input state is set to 'ON' for a short periode, independent from activation time. - The activation time and sequence is reprensented by the readings input_<ch>_action and input_<ch>_actionS, + The activation time and sequence is reprensented by the readings input_<ch>_action and input_<ch>_actionS, which will act simultanously with following values:
        • S single_push
          • @@ -6142,32 +7713,32 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        • SSS triple_push
        • L long_push
        - - NOTE: the readings of an input in mode 'button' cannot actualized by polling. + + NOTE: the readings of an input in mode 'button' cannot actualized by polling. It is necessary to set actions/webhooks on the Shelly! - +

        Webhooks on ShellyPlusI4
        Webhooks generated by Fhem are named as follows: -
        Input mode 'switch' -
          +
          Input mode 'switch' +
          • _INPUT.TOGGLE_ON_
          • _INPUT.TOGGLE_OFF_
          - +
          Input mode 'button'
          • _INPUT.BUTTON_PUSH_
          • _INPUT.BUTTON_DOUBLEPUSH_
            • -
          • _INPUT.BUTTON_TRIPLEPUSH
            • _ +
          • _INPUT.BUTTON_TRIPLEPUSH
            • _
          • _INPUT.BUTTON_LONGPUSH_
          - - + +
          ShellyPro3EM
          - +
          Power
          - + Power, Voltage, Current and Power-Factor are updated at the main interval, unless otherwise specified
        • Active Power @@ -6184,7 +7755,7 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        • Pushed Power
          Active_Power_pushed_<A|B|C|T> -
          float values of the actual power pushed by the Shelly when the value of a phase differs at least 10% to the previous sent value +
          float values of the actual power pushed by the Shelly when the value of a phase differs at least 10% to the previous sent value (update interval depends on load, possible minimum is 1 second) Action on power-events on the Shelly must be enabled.
          • @@ -6193,16 +7764,16 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
          Apparent_Power_<A|B|C|T>
          float values of the actual apparent power
        • - Voltage, Current and Power-Factor + Voltage, Current and Power-Factor
          Voltage_<A|B|C>
          Current_<A|B|C|T>
          Power_Factor_<A|B|C>
          float values of the actual voltage, current and power factor
          • Energy
          - + Energy readings are updated each minute, or multiple. -
          When the showunits attribute is set, the associated units (Wh, kWh, kJ) are appended to the values +
          When the showunits attribute is set, the associated units (Wh, kWh, kJ) are appended to the values
        • Active Energy
          Purchased_Energy_<A|B|C|T> @@ -6211,14 +7782,14 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        • Total Active Energy
          Total_Energy -
          float value of total purchased energy minus total returned energy +
          float value of total purchased energy minus total returned energy
          A minus sign is indicating returned energy.
          The timestamp of the reading is set to the full minute, as this is Shellies time base. - Day and Week are based on GMT. + Day and Week are based on GMT.
          • - +
        • - Energymeter + Energymeter
          Total_Energymeter_<F|P|R>
          float values of the purchased (P) or returned (R) energy displayed by the suppliers meter. For Ferraris type meters (F), the returned energy is subtracted from the purchased energy
          • @@ -6232,7 +7803,7 @@ Shelly_readingsBulkUpdate($$$@) # derived from fhem.pl readingsBulkUpdateIfChang
        • Week is a period of 7 days, starting mondays at 00:00.
        - +
    =end html_DE