| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229 |
- ########################################################################################
- #
- # OWCOUNT.pm
- #
- # FHEM module to commmunicate with 1-Wire Counter/RAM DS2423
- #
- # Prof. Dr. Peter A. Henning
- # Norbert Truchsess
- #
- # $Id: 21_OWCOUNT.pm 11196 2016-04-06 18:56:28Z pahenning $
- #
- ########################################################################################
- #
- # define <name> OWCOUNT [<model>] <ROM_ID> [interval] or OWCOUNT <FAM_ID>.<ROM_ID> [interval]
- #
- # where <name> may be replaced by any name string
- #
- # <model> is a 1-Wire device type DS2423,DS2423ene,wDS2423eold. If omitted, we assume this to be an
- # DS2423 Counter/RAM
- # <FAM_ID> is a 1-Wire family id, currently allowed value is 1D
- # <ROM_ID> is a 12 character (6 byte) 1-Wire ROM ID
- # without Family ID, e.g. A2D90D000800
- # [interval] is an optional query interval in seconds
- #
- # get <name> id => FAM_ID.ROM_ID.CRC
- # get <name> present => 1 if device present, 0 if not
- # get <name> interval => query interval
- # get <name> memory <page> => 32 byte string from page 0..13
- # get <name> midnight <channel> => todays starting value (formatted) for counter
- # get <name> month => summary and average for month
- # get <name> year => summary and average for year
- # get <name> raw <channel> => raw value for counter
- # get <name> counters => formatted values for both counters
- # get <name> version => OWX version number
- #
- # set <name> interval => set query interval for measurement
- # set <name> memory <page> => 32 byte string into page 0..13
- # set <name> midnight <channel> => todays starting value for counter
- # set <name> counter <channel> => correct midnight value such that
- # counter shows this value
- #
- # Additional attributes are defined in fhem.cfg, in some cases per channel, where <channel>=A,B
- #
- # attr <name> LogM <string> = device name (not file name) of monthly log file
- # attr <name> LogY <string> = device name (not file name) of yearly log file
- # attr <name> nomemory = 1|0 (when set to 1, disables use of internal memory)
- # attr <name> <channel>Name <string>[|<string>] = name for the channel [|short name used in state reading]
- # attr <name> <channel>Unit <string> = unit of measurement used in state reading (default cts, none for empty)
- # attr <name> <channel>Rate <string>[|<string>] = name for the channel rate [|short name used in state reading]
- # attr <name> <channel>Offset <float> = offset added to the reading in this channel
- # attr <name> <channel>Factor <float> = factor multiplied to (reading+offset) in this channel
- # attr <name> <channel>Mode <string> = counting mode = normal(default) or daily
- # attr <name> <channel>Period <string> = period for rate calculation = hour (default), minute or second
- #
- # In normal counting mode each returned counting value will be factor*(reading+offset)
- # In daily counting mode each returned counting value will be factor*(reading+offset)-midnight
- # where midnight is stored as string in the 32 byte memory associated with the counter
- #
- # Log Lines
- # after each interval <date> <name> <channel>: <value> <unit> <value> / <unit>/<period> <channel>: <value> <unit> / <value> <unit>/<period>
- # example: 2012-07-30_00:07:55 OWX_C Taste: 17.03 p 28.1 p/h B: 7.0 cts 0.0 cts/min
- # after midnight <new date> <name> <old day> <old date> <channel>: <value> <unit> <channel>: <value> <unit>
- # example: 2012-07-30_00:00:57 OWX_C D29: 2012-7-29_23:59:59 Taste: 110.0 p, B: 7.0 cts
- ########################################################################################
- #
- # This programm is free software; you can redistribute it and/or modify
- # it under the terms of the GNU General Public License as published by
- # the Free Software Foundation; either version 2 of the License, or
- # (at your option) any later version.
- #
- # The GNU General Public License can be found at
- # http://www.gnu.org/copyleft/gpl.html.
- # A copy is found in the textfile GPL.txt and important notices to the license
- # from the author is found in LICENSE.txt distributed with these scripts.
- #
- # This script is distributed in the hope that it will be useful,
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- # GNU General Public License for more details.
- #
- ########################################################################################
- package main;
- use vars qw{%attr %defs %modules $readingFnAttributes $init_done};
- use strict;
- use warnings;
- #add FHEM/lib to @INC if it's not already included. Should rather be in fhem.pl than here though...
- BEGIN {
- if (!grep(/FHEM\/lib$/,@INC)) {
- foreach my $inc (grep(/FHEM$/,@INC)) {
- push @INC,$inc."/lib";
- };
- };
- };
- use ProtoThreads;
- no warnings 'deprecated';
- sub Log3($$$);
- my $owx_version="6.01";
- #-- fixed raw channel name, flexible channel name
- my @owg_fixed = ("A","B");
- my @owg_channel = ("A","B");
- my @owg_rate = ("A_rate","B_rate");
- #-- initially assume that both memory types (low, high) are present
- my @owg_memory = (1,1,0);
- my $owgmodel;
- my $owgauto = 0;
- my %gets = (
- "id" => "",
- "present" => "",
- "interval" => "",
- "memory" => "",
- "midnight" => "",
- "raw" => "",
- "counters" => "",
- "month" => "",
- "year" => "",
- "version" => ""
- );
- my %sets = (
- "interval" => "",
- "memory" => "",
- "midnight" => "",
- "counter" => ""
- );
- my %updates = (
- "present" => "",
- "counter" => ""
- );
- ########################################################################################
- #
- # The following subroutines are independent of the bus interface
- #
- # Prefix = OWCOUNT
- #
- ########################################################################################
- #
- # OWCOUNT_Initialize
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_Initialize ($) {
- my ($hash) = @_;
- $hash->{DefFn} = "OWCOUNT_Define";
- $hash->{UndefFn} = "OWCOUNT_Undef";
- $hash->{GetFn} = "OWCOUNT_Get";
- $hash->{SetFn} = "OWCOUNT_Set";
- $hash->{NotifyFn}= "OWCOUNT_Notify";
- $hash->{InitFn} = "OWCOUNT_Init";
- $hash->{AttrFn} = "OWCOUNT_Attr";
- #-- see header for attributes
- my $attlist = "IODev do_not_notify:0,1 showtime:0,1 model:DS2423,DS2423enew,DS2423eold LogM LogY ".
- "nomemory:1,0 interval ".
- $readingFnAttributes;
- for( my $i=0;$i<int(@owg_fixed);$i++ ){
- $attlist .= " ".$owg_fixed[$i]."Name";
- $attlist .= " ".$owg_fixed[$i]."Rate";
- $attlist .= " ".$owg_fixed[$i]."Offset";
- $attlist .= " ".$owg_fixed[$i]."Factor";
- $attlist .= " ".$owg_fixed[$i]."Unit";
- $attlist .= " ".$owg_fixed[$i]."Mode:normal,daily";
- $attlist .= " ".$owg_fixed[$i]."Period:hour,minute,second";
- }
- $hash->{AttrList} = $attlist;
-
- #-- make sure OWX is loaded so OWX_CRC is available if running with OWServer
- main::LoadModule("OWX");
- }
- #########################################################################################
- #
- # OWCOUNT_Define - Implements DefFn function
- #
- # Parameter hash = hash of device addressed, def = definition string
- #
- #########################################################################################
- sub OWCOUNT_Define ($$) {
- my ($hash, $def) = @_;
-
- my @a = split("[ \t][ \t]*", $def);
- my ($name,$model,$fam,$id,$crc,$interval,$scale,$ret);
-
- #-- default
- $name = $a[0];
- $interval = 300;
- $scale = "";
- $ret = "";
- #-- check syntax
- return "OWCOUNT: Wrong syntax, must be define <name> OWCOUNT [<model>] <id> [interval] or OWCOUNT <fam>.<id> [interval]"
- if(int(@a) < 2 || int(@a) > 5);
-
- #-- different types of definition allowed
- my $a2 = $a[2];
- my $a3 = defined($a[3]) ? $a[3] : "";
- #-- The model may be DS2423 or DS2423emu. Some weird people are violating 1-Wire integrity by using the
- # the same family ID although the DS2423emu does not fully support the DS2423 commands.
- # Model attribute will be modified later when memory is checked
- #-- no model, 12 characters
- if( $a2 =~ m/^[0-9|a-f|A-F]{12}$/ ) {
- $model = "DS2423";
- $owgauto =1;
- #CommandAttr (undef,"$name model DS2423");
- $fam = "1D";
- $id = $a[2];
- if(int(@a)>=4) { $interval = $a[3]; }
- #-- no model, 2+12 characters
- } elsif( $a2 =~ m/^[0-9|a-f|A-F]{2}\.[0-9|a-f|A-F]{12}$/ ) {
- $fam = substr($a[2],0,2);
- $id = substr($a[2],3);
- if(int(@a)>=4) { $interval = $a[3]; }
- if( $fam eq "1D" ){
- $model = "DS2423";
- $owgauto =1;
- #CommandAttr (undef,"$name model DS2423");
- }else{
- return "OWCOUNT: Wrong 1-Wire device family $fam";
- }
- #-- model, 12 characters
- } elsif( $a3 =~ m/^[0-9|a-f|A-F]{12}$/ ) {
- $model = $a[2];
- $id = $a[3];
- if(int(@a)>=5) { $interval = $a[4]; }
- if( $model eq "DS2423" ){
- $fam = "1D";
- #CommandAttr (undef,"$name model DS2423");
- #-- Check, if name might be from autocreate -> checking memory
- if( $name =~ /OWX\_$fam\_$id/ ){
- $owgauto=1;
- }
- @owg_memory = (1,1,0);
- }elsif( $model eq "DS2423enew" ){
- $fam = "1D";
- @owg_memory = (1,1,0);
- #CommandAttr (undef,"$name model DS2423enew");
- }elsif( $model eq "DS2423eold" ){
- $fam = "1D";
- #CommandAttr (undef,"$name model DS2423eold");
- #CommandAttr (undef,"$name nomemory 1");
- @owg_memory = (0,0,0);
- }else{
- return "OWCOUNT: Wrong 1-Wire device model $model";
- }
- } else {
- return "OWCOUNT: $a[0] ID $a[2] invalid, specify a 12 or 2.12 digit value";
- }
-
- $owgmodel=$model;
-
- # determine CRC Code - only if this is a direct interface
- $crc = sprintf("%02x",OWX_CRC($fam.".".$id."00"));
-
- #-- Define device internals
- $hash->{ROM_ID} = "$fam.$id.$crc";
- $hash->{OW_ID} = $id;
- $hash->{OW_FAMILY} = $fam;
- $hash->{PRESENT} = 0;
- $hash->{INTERVAL} = $interval;
-
- #-- Couple to I/O device
- AssignIoPort($hash);
- if( !defined($hash->{IODev}) or !defined($hash->{IODev}->{NAME}) ){
- return "OWCOUNT: Warning, no 1-Wire I/O device found for $name.";
- } else {
- $hash->{ASYNC} = $hash->{IODev}->{TYPE} eq "OWX_ASYNC" ? 1 : 0; #-- false for now
- }
- $modules{OWCOUNT}{defptr}{$id} = $hash;
-
-
-
-
- #--
- readingsSingleUpdate($hash,"state","defined",1);
- Log3 $name, 3, "OWCOUNT: Device $name defined.";
-
- $hash->{NOTIFYDEV} = "global";
-
- if ($init_done) {
- OWCOUNT_Init($hash);
- }
- return undef;
- }
- #######################################################################################
- #
- # OWCOUNT_Notify - Implements Notify function
- #
- # Parameter hash = hash of device addressed
- # dev = device
- #
- ########################################################################################
- sub OWCOUNT_Notify ($$) {
- my ($hash,$dev) = @_;
- if( grep(m/^(INITIALIZED|REREADCFG)$/, @{$dev->{CHANGED}}) ) {
- OWCOUNT_Init($hash);
- } elsif( grep(m/^SAVE$/, @{$dev->{CHANGED}}) ) {
- }
- }
- #######################################################################################
- #
- # OWCOUNT_Init - Implements Init function
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_Init ($) {
- my ($hash)=@_;
-
- #-- Start timer for updates
- RemoveInternalTimer($hash);
- InternalTimer(gettimeofday()+10, "OWCOUNT_GetValues", $hash, 0);
- return undef;
- }
- ########################################################################################
- #
- # OWCOUNT_InitializeDevice - delayed setting of initial readings and channel names
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_InitializeDevice($) {
- my ($hash) = @_;
-
- my $name = $hash->{NAME};
- #-- get memory page/counter according to interface type
- my $master= $hash->{IODev};
- my $interface= $hash->{IODev}->{TYPE};
-
- my $olddata = "";
- my ($olddata1,$olddata2);
- my $newdata = "OWCOUNT ".$owx_version;
- my $ret;
-
- #-- post-define: check model
- if( !defined($attr{$hash->{NAME}}{"model"}) ){
- CommandAttr (undef,$hash->{NAME}." model $owgmodel");
- }
-
- #-- initial values
- for( my $i=0;$i<int(@owg_fixed);$i++) {
- #-- initial readings
- $hash->{owg_val}->[$i] = "";
- $hash->{owg_midnight}->[$i] = "";
- $hash->{owg_str}->[$i] = "";
- }
-
- #-- Set state to initialized
- readingsSingleUpdate($hash,"state","initialized",1);
-
- return undef;
- }
- #######################################################################################
- #
- # OWCOUNT_Attr - Set one attribute value for device
- #
- # Parameter hash = hash of device addressed
- # a = argument array
- #
- ########################################################################################
- sub OWCOUNT_Attr(@) {
- my ($do,$name,$key,$value) = @_;
-
- my $hash = $defs{$name};
- my $ret;
-
- if ( $do eq "set") {
- ARGUMENT_HANDLER: {
- #-- interval modified at runtime
- $key eq "interval" and do {
- #-- check value
- return "OWCOUNT: Set with short interval, must be > 1" if(int($value) < 1);
- #-- update timer
- $hash->{INTERVAL} = $value;
- if ($init_done) {
- RemoveInternalTimer($hash);
- InternalTimer(gettimeofday()+$hash->{INTERVAL}, "OWCOUNT_GetValues", $hash, 0);
- }
- last;
- };
- $key eq "IODev" and do {
- AssignIoPort($hash,$value);
- if( defined($hash->{IODev}) ) {
- $hash->{ASYNC} = $hash->{IODev}->{TYPE} eq "OWX_ASYNC" ? 1 : 0;
- if ($init_done) {
- OWCOUNT_Init($hash);
- }
- }
- last;
- };
- }
- }
- return $ret;
- }
- ########################################################################################
- #
- # OWCOUNT_ChannelNames - find the real channel names
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_ChannelNames($) {
- my ($hash) = @_;
-
- my $name = $hash->{NAME};
- my $state = $hash->{READINGS}{"state"}{VAL};
-
- my ($cname,@cnama,$unit,@unarr,$runit,$period);
- for (my $i=0;$i<int(@owg_fixed);$i++){
- #-- name
- $cname = defined($attr{$name}{$owg_fixed[$i]."Name"}) ? $attr{$name}{$owg_fixed[$i]."Name"} : "$owg_fixed[$i]";
- @cnama = split(/\|/,$cname);
- if( int(@cnama)!=2){
- push(@cnama,$cnama[0]);
- }
- #-- unit
- $unit = defined($attr{$name}{$owg_fixed[$i]."Unit"}) ? $attr{$name}{$owg_fixed[$i]."Unit"} : "cts";
- if( $unit eq "none" ){
- $unit = "";
- }else{
- $unit = " ".$unit;
- }
-
- #-- put into readings
- $owg_channel[$i]=$cnama[0];
- $hash->{READINGS}{$owg_channel[$i]}{ABBR} = $cnama[1];
- $hash->{READINGS}{$owg_channel[$i]}{UNIT} = $unit;
-
- $period = defined($attr{$name}{$owg_fixed[$i]."Period"}) ? $attr{$name}{$owg_fixed[$i]."Period"} : "hour";
- #-- put into readings
- $hash->{READINGS}{$owg_channel[$i]}{PERIOD} = $period;
- #-- rate
- $cname = defined($attr{$name}{$owg_fixed[$i]."Rate"}) ? $attr{$name}{$owg_fixed[$i]."Rate"} :
- (defined($attr{$name}{$owg_fixed[$i]."Name"}) ? "$cnama[0]_rate|$cnama[1]_r" : "$owg_fixed[$i]_rate|$owg_fixed[$i]_r");
- @cnama = split(/\|/,$cname);
- if( int(@cnama)!=2){
- push(@cnama,$cnama[0]);
- }
-
- #-- rate unit
- if( $unit ne " " ){
- if( $period eq "hour" ){
- $unit .= "/h";
- }elsif( $period eq "minute" ){
- $unit .= "/min";
- } else {
- $unit .= "/s";
- }
- }
-
- #-- some special cases
- # Energy/Power
- $unit = " kW"
- if ($unit eq " kWh/h" );
- #-- put into readings
- $owg_rate[$i]=$cnama[0];
- $hash->{READINGS}{$owg_rate[$i]}{ABBR} = $cnama[1];
- $hash->{READINGS}{$owg_rate[$i]}{UNIT} = $unit;
- }
- }
- ########################################################################################
- #
- # OWCOUNT_FormatValues - put together various format strings and assemble STATE variable
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_FormatValues($) {
- my ($hash) = @_;
-
- my $name = $hash->{NAME};
- my ($offset,$factor,$period,$unit,$runit,$vval,$vrate);
- my ($svalue,$dvalue,$mvalue) = ("","","");
- my $galarm = 0;
-
- my ($sec, $min, $hour, $day, $month, $year, $wday,$yday,$isdst) = localtime(time);
- my ($seco,$mino,$houro,$dayo,$montho,$yearo,$dayrest);
- my ($daily, $dt,$dval,$dval2,$deltim,$delt,$delf);
- my ($total,$total0,$total1,$total2,$total3,@monthv,@yearv);
- my $daybreak = 0;
- my $monthbreak = 0;
-
- #-- no change in any value if invalid reading
- for (my $i=0;$i<int(@owg_fixed);$i++){
- return if( $hash->{owg_val}->[$i] eq "");
- }
-
- #-- obtain channel names
- OWCOUNT_ChannelNames($hash);
-
- #-- Check, whether we have a new day at the next reading
- $deltim = $hour*60.0+$min+$sec/60.0 - (1440 - $hash->{INTERVAL}/60.0);
- #$deltim = $min+$sec/60.0 - 55;
- if( $deltim>=0 ){
- $daybreak = 1;
- $monthbreak = 0;
- #-- Timer data from tomorrow
- my ($secn,$minn,$hourn,$dayn,$monthn,$yearn,$wdayn,$ydayn,$isdstn) = localtime(time() + $hash->{INTERVAL} + 3600);
- #-- Check, whether we have a new month
- if( $dayn == 1 ){
- $monthbreak = 1;
- }
- }
-
- #-- put into READING
- readingsBeginUpdate($hash);
-
- #-- Check memory string only if model is defined automatically
- if( $owgauto ){
- my $msg = "OWCOUNT: In device $name, ";
- if( $owg_memory[2]==1 ){
- if( ($owg_memory[0]==1) && ($owg_memory[1]==1) ){
- Log 1, $msg."memory pages 0..13 and midnight store present, model should be DS2423"
- if( $attr{$name}{"model"} ne "DS2423");
- }elsif( ($owg_memory[0]==0) && ($owg_memory[1]==1) ){
- Log 1, $msg."midnight store only, model should be DS2423enew"
- if( $attr{$name}{"model"} ne "DS2423enew");
- }else{
- Log 1, $msg."no memory pages and no midnight store found, model should be DS2423eold"
- if( $attr{$name}{"model"} ne "DS2423eold");
- }
- $owg_memory[2]=0;
- }
- $owgauto=0;
- }
-
- #-- formats for output
- for (my $i=0;$i<int(@owg_fixed);$i++){
-
- #-- mode normal or daily
- $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$i]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$i]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- #-- offset and scale factor
- $offset = defined($attr{$name}{$owg_fixed[$i]."Offset"}) ? $attr{$name}{$owg_fixed[$i]."Offset"} : 0;
- $factor = defined($attr{$name}{$owg_fixed[$i]."Factor"}) ? $attr{$name}{$owg_fixed[$i]."Factor"} : 1;
-
- #-- put into READINGS
- $hash->{READINGS}{$owg_channel[$i]}{OFFSET} = $offset;
- $hash->{READINGS}{$owg_channel[$i]}{FACTOR} = $factor;
-
- $unit = $hash->{READINGS}{$owg_channel[$i]}{UNIT};
- $period = $hash->{READINGS}{$owg_channel[$i]}{PERIOD};
- $runit = $hash->{READINGS}{$owg_rate[$i]}{UNIT};
-
- #-- skip some things if undefined
- if( $hash->{owg_val}->[$i] eq ""){
- $svalue .= $owg_channel[$i]." ???";
- }else{
- #-- only if attribute value mode=daily, take the midnight value from memory
- if( $daily == 1){
- $vval = int( (($hash->{owg_val}->[$i] + $offset)*$factor - $hash->{owg_midnight}->[$i])*10000+0.5)/10000;
- } else {
- $vval = int( ($hash->{owg_val}->[$i] + $offset)*$factor*10000+0.5)/10000;
- }
-
- #-- rate calculation: get the old values
- my $oldval = $hash->{READINGS}{$owg_channel[$i]}{VAL};
- my $oldtim = $hash->{READINGS}{$owg_channel[$i]}{TIME};
- $oldtim = "" if(!defined($oldtim));
-
- #-- safeguard against the case where no previous measurement
- if( length($oldtim) > 0 ){
- #-- correct counter wraparound since last reading
- if( $vval < $oldval) {
- $oldval -= (65536*$factor);
- }
- #-- previous measurement time
- ($yearo,$montho,$dayrest) = split(/-/,$oldtim);
- $dayo = substr($dayrest,0,2);*60=
- ($houro,$mino,$seco) = split(/:/,substr($dayrest,3));
-
- #-- time difference to previous measurement and to midnight
- $delt = ($hour-$houro)*3600 + ($min-$mino)*60 + ($sec-$seco);
- $delf = $hour *3600 + $min *60 + $sec - 86400;
-
- #-- rate
- if( $delt > 0.0){
- $vrate = ($vval-$oldval)/$delt;
- } else {
- $vrate = 0.0;
- }
- #-- correct rate for period setting
- if( $period eq "hour" ){
- $vrate*=3600;
- }elsif( $period eq "minute" ){
- $vrate*=60;
- }
- $vrate = int($vrate * 10000+0.5)/10000;
-
- #--midnight extrapolation only possible if previous measurement
- if( $daybreak==1 ){
- #-- linear extrapolation
- $dt = -$delf/$delt;
- $dval = int(($vval+($vval-$oldval)*$dt)*10000+0.5)/10000;
-
- if( $daily == 1 ){
- $dval2 = $dval+$hash->{owg_midnight}->[$i];
- } else {
- $dval2 = $dval;
- }
-
- #-- in any mode store the interpolated value in the midnight store
- my $msg = sprintf("%4d-%02d-%02d midnight %7.2f",
- $year+1900,$month+1,$day,$dval2);
- OWCOUNT_SetPage($hash,14+$i,$msg);
- Log3 $name,5,"OWCOUNT: measured value $vval (midnight ".$hash->{owg_midnight}->[$i].") => new extrapolated midnight $dval2";
-
- #-- string buildup for monthly and yearly logging
- $dvalue .= sprintf( " %s: %5.2f %s %sM: %%5.2f %s", $owg_channel[$i],$dval,$unit,$owg_channel[$i],$unit);
- $mvalue .= sprintf( " %sM: %%5.2f %s %sY: %%5.2f %s", $owg_channel[$i],$unit,$owg_channel[$i],$unit);
- } #-- end daybreak
-
- #-- string buildup for return value and STATE
- #-- 1 or 3 decimals
- my $fs = ( $factor == 1.0 )? "%s: %5.2f %s %s: %5.2f %s" : "%s: %5.3f %s %s: %5.3f %s";
- $svalue .= sprintf( $fs, $hash->{READINGS}{$owg_channel[$i]}{ABBR}, $vval,$unit,$hash->{READINGS}{$owg_rate[$i]}{ABBR},$vrate,$runit);
- #-- 3 decimals
- }
- readingsBulkUpdate($hash,$owg_channel[$i],$vval);
- readingsBulkUpdate($hash,$owg_rate[$i],$vrate);
- }
- #-- insert space
- if( $i<int(@owg_fixed)-1 ){
- $svalue .= " ";
- $dvalue .= " ";
- }
- }#-- end channel loop
-
- #-- daybreak postprocessing
- if( $daybreak == 1 ){
- #-- daily/monthly accumulated value
- @monthv = OWCOUNT_GetMonth($hash);
- @yearv = OWCOUNT_GetYear($hash);
- #-- put in monthly and yearly sums
- if( int(@monthv) == 2 ){
- $total0 = $monthv[0]->[1];
- $total1 = ($day==1)?$total0:$monthv[1]->[1];
- $dvalue = sprintf("D%02d ",$day).$dvalue;
- $dvalue = sprintf($dvalue,$total0,$total1);
- readingsBulkUpdate($hash,"day",$dvalue);
- }else{
- Log3 $name,3,"OWCOUNT: No monthly summary possible, ".$monthv[0]." for device $name";
- $total0 = 0;
- $total1 = 0;
- };
-
- if( int(@yearv) == 2 ){
- $total2 = $yearv[0]->[1];
- $total3 = ($month==0)?$total2: $yearv[1]->[1];
- if ( $monthbreak == 1){
- $mvalue = sprintf("M%02d ",$month+1).$mvalue;
- $mvalue = sprintf($mvalue,$total0,$total2,$total1,$total3);
- readingsBulkUpdate($hash,"month",$mvalue);
- }
- }else{
- Log3 $name,3,"OWCOUNT: No yearly summary possible, ".$yearv[0]." for device $name";
- $total2 = 0;
- $total3 = 0;
- };
- }
-
- #-- STATE
- readingsBulkUpdate($hash,"state",$svalue);
- readingsEndUpdate($hash,1);
-
- return $svalue;
- }
- ########################################################################################
- #
- # OWCOUNT_Get - Implements GetFn function
- #
- # Parameter hash = hash of device addressed, a = argument array
- #
- ########################################################################################
- sub OWCOUNT_Get($@) {
- my ($hash, @a) = @_;
-
- my $reading = $a[1];
- my $name = $hash->{NAME};
- my $model = $hash->{OW_MODEL};
- my $master = $hash->{IODev};
- my $value = undef;
- my $ret = "";
- my $page;
- my ($unit,$daily);
- my ($ret1,$ret2);
- #-- check syntax
- return "OWCOUNT: Get argument is missing @a"
- if(int(@a) < 2);
-
- #-- check argument
- return "OWCOUNT: Get with unknown argument $a[1], choose one of ".join(" ", sort keys %gets)
- if(!defined($gets{$a[1]}));
- #-- get id
- if($a[1] eq "id") {
- $value = $hash->{ROM_ID};
- return "$name.id => $value";
- }
-
- #-- get present
- if($a[1] eq "present") {
- #-- hash of the busmaster
- my $master = $hash->{IODev};
-
- #-- normal OWX
- if( !$hash->{ASYNC} ){
- $value = OWX_Verify($master,$hash->{ROM_ID});
- $hash->{PRESENT} = $value;
- return "$name.present => $value";
- #-- old asynchronous mode
- }else{
- eval {
- OWX_ASYNC_RunToCompletion($hash,OWX_ASYNC_PT_Verify($hash));
- };
- return GP_Catch($@) if $@;
- return "$name.present => ".ReadingsVal($name,"present","unknown");
- }
- }
- #-- get interval
- if($a[1] eq "interval") {
- $value = $hash->{INTERVAL};
- return "$name.interval => $value";
- }
-
- #-- get version
- if( $a[1] eq "version") {
- return "$name.version => $owx_version";
- }
-
- #-- get channel names
- OWCOUNT_ChannelNames($hash);
-
- #-- get month
- if($a[1] eq "month") {
- $value="$name.month =>\n";
- my @month2 = OWCOUNT_GetMonth($hash);
- #-- error case
- if( int(@month2) != 2 ){
- return $value." no monthly summary possible, ".$month2[0];
- }
- #-- 3 entries for each day
- for(my $i=0;$i<int(@month2);$i++){
- $unit = $hash->{READINGS}{$owg_channel[$i]}{UNITABBR};
- #-- mode = daily ?
- $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$i]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$i]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- if( $daily==1){
- $value .= $owg_channel[$i]."M: ".$month2[$i]->[1]." ".$unit.
- " (monthly sum until now, average ".$month2[$i]->[2]." ".$unit."/d)\n";
- }else{
- $value .= $owg_channel[$i]."M: ".$month2[$i]->[1]." ".$unit." (last midnight)\n";
- }
- }
- return $value;
- }
-
- #-- get year
- if($a[1] eq "year") {
- $value="$name.year =>\n";
- my @year2 = OWCOUNT_GetYear($hash);
- #-- error case
- if( int(@year2) != 2 ){
- return $value." no yearly summary possible, ".$year2[0];
- }
- #-- 3 entries for each month
- for(my $i=0;$i<int(@year2);$i++){
- $unit = $hash->{READINGS}{$owg_channel[$i]}{UNITABBR};
- #-- mode = daily ?
- $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$i]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$i]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- if( $daily==1){
- $value .= $owg_channel[$i]."Y: ".$year2[$i]->[1]." ".$unit.
- " (yearly sum until now, average ".$year2[$i]->[2]." ".$unit."/d)\n";
- }else{
- $value .= $owg_channel[$i]."Y: ".$year2[$i]->[1]." ".$unit."\n";
- }
- }
- return $value;
- }
-
- #-- get memory page/counter according to interface type
- my $interface= $hash->{IODev}->{TYPE};
-
- #-- check syntax for getting memory page 0..13 or midnight A/B
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
- if( $reading eq "memory" ){
- return "OWCOUNT: Memory usage disabled"
- if( $nomemory==1 );
- return "OWCOUNT: Get needs parameter when reading memory: <page>"
- if( int(@a)<2 );
- $page=int($a[2]);
- if( ($page<0) || ($page>13) ){
- return "OWCOUNT: Wrong memory page requested";
- }
- $ret = OWCOUNT_GetPage($hash,$page,1,1);
- #-- process result
- if( $master->{ASYNCHRONOUS} ){
- return "OWCOUNT: $name getting memory $page, please wait for completion";
- }else{
- #-- when we have a return code, we have an error
- if( $ret ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }else{
- return "OWCOUNT: $name.$reading [$page] =>".$hash->{owg_str}->[$page];
- }
- }
- }
- if( $reading eq "midnight" ){
- return "OWCOUNT: get needs parameter when reading midnight: <channel>"
- if( int(@a)<3 );
- #-- find out which channel we have
- if( ($a[2] eq $owg_channel[0]) || ($a[2] eq "A") ){
- $page=14;
- }elsif( ($a[2] eq $owg_channel[1]) || ($a[2] eq "B") ){
- $page=15;
- } else {
- return "OWCOUNT: Invalid midnight counter address, must be A, B or defined channel name"
- }
- $ret = OWCOUNT_GetPage($hash,$page,1,1);
- #-- process result
- if( $master->{ASYNCHRONOUS} ){
- return "OWCOUNT: $name getting midnight value $page and counter, please wait for completion";
- }else{
- #-- when we have a return code, we have an error
- if( $ret ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }else{
- return "OWCOUNT: $name.$reading [$page] =>".$hash->{owg_midnight}->[$page-14];
- }
- }
- }
-
- #-- check syntax for getting counter
- if( $reading eq "raw" ){
- return "OWCOUNT: Get needs parameter when reading raw counter: <channel>"
- if( int(@a)<2 );
- #-- find out which channel we have
- if( ($a[2] eq $owg_channel[0]) || ($a[2] eq "A") ){
- $page=14;
- }elsif( ($a[2] eq $owg_channel[1]) || ($a[2] eq "B") ){
- $page=15;
- } else {
- return "OWCOUNT: Invalid counter address, must be A, B or defined channel name"
- }
- $ret = OWCOUNT_GetPage($hash,$page,1,1);
- #-- process result
- if( $master->{ASYNCHRONOUS} ){
- return "OWCOUNT: $name getting page $page and counter, please wait for completion";
- }else{
- #-- when we have a return code, we have an error
- if( $ret ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }
- #-- only one counter will be returned
- return "OWCOUNT: $name.raw $a[2] => ".$hash->{owg_val}->[$page-14];
- }
- #-- check syntax for getting counters
- }elsif( $reading eq "counters" ){
- return "OWCOUNT: Get needs no parameter when reading counters"
- if( int(@a)==1 );
- $ret1 = OWCOUNT_GetPage($hash,14,0,1);
- $ret2 = OWCOUNT_GetPage($hash,15,1,1);
- #-- process result
- if( $master->{ASYNCHRONOUS} ){
- return "OWCOUNT: $name getting counters, please wait for completion";
- }else{
- $ret .= $ret1
- if( defined($ret1) );
- $ret .= $ret2
- if( defined($ret2) );
- if( defined($ret1) || defined($ret2) ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }
- #-- both counters will be returned
- return "OWCOUNT: $name.counters => ".$hash->{READINGS}{"state"}{VAL};
- }
- }
- }
- #######################################################################################
- #
- # OWCOUNT_GetPage - Get a memory page
- #
- # Parameter hash = hash of device addressed
- # page = page addressed
- # final= 1 if FormatValues is to be called
- #
- ########################################################################################
- sub OWCOUNT_GetPage ($$$@) {
- my ($hash, $page,$final,$sync) = @_;
-
- #-- get memory page/counter according to interface type
- my $master= $hash->{IODev};
- my $interface= $hash->{IODev}->{TYPE};
- my $name = $hash->{NAME};
- my $ret;
-
- #-- check if memory usage has been disabled
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
-
- #-- even if memory usage has been disabled, we need to read the page because it contains the counter values
- if( ($nomemory==0) || ($nomemory==1 && (($page==14)||($page==15))) ){
- #-- OWX interface
- if( $interface eq "OWX" ){
- $ret = OWXCOUNT_GetPage($hash,$page,$final);
- }elsif( $interface eq "OWX_ASYNC" ){
- eval {
- if ($sync) {
- $ret = OWX_ASYNC_RunToCompletion($hash,OWXCOUNT_PT_GetPage($hash,$page,$final));
- } else {
- OWX_ASYNC_Schedule( $hash, OWXCOUNT_PT_GetPage($hash,$page,$final) );
- }
- };
- $ret = GP_Catch($@) if $@;
- #-- OWFS interface
- }elsif( $interface eq "OWServer" ){
- $ret = OWFSCOUNT_GetPage($hash,$page,$final);
- #-- Unknown interface
- }else{
- return "OWCOUNT: GetPage with wrong IODev type $interface";
- }
- #-- process results
- if( defined($ret) ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }
- }
- return undef
- }
- ########################################################################################
- #
- # OWCOUNT_GetMonth Read monthly data from a file
- #
- # Parameter hash
- #
- # Returns total value up to last day, including this day and average including this day
- #
- ########################################################################################
- sub OWCOUNT_GetMonth($) {
- my ($hash) = @_;
- my $name = $hash->{NAME};
- my $regexp = ".*$name.*";
- my $val;
- my @month = ();
- my @month2 = ();
- my @mchannel;
- my @linarr;
- my $day;
- my $line;
- my ($total,$total2,$daily,$deltim,$av);
- #-- Check current logfile
- my $ln = $attr{$name}{"LogM"};
- if( !(defined($ln))){
- return "attribute LogM is missing";
- }
-
- #-- get channel names
- OWCOUNT_ChannelNames($hash);
-
- my $lf = $defs{$ln}{currentlogfile};
- if( !(defined($lf))){
- return "logfile of LogM is missing";
- }
-
- #-- current date
- my ($csec,$cmin,$chour,$cday,$cmonth,$cyear,$cwday,$cyday,$cisdst) = localtime(time);
-
- my $ret = open(OWXFILE, "< $lf" );
- if( $ret) {
- while( <OWXFILE> ){
- #-- line looks as
- # 2013-06-25_23:57:57 DG.CT1 day: D25 W: 42.2 kWh Wm: 84.4 kWh B: 2287295.7 cts Bm: 2270341.0 cts
- $line = $_;
- chomp($line);
- if ( $line =~ m/$regexp/i){
- @linarr = split(' ',$line);
- if( int(@linarr)==4+6*int(@owg_fixed) ){
- $day = $linarr[3];
- $day =~ s/D_+0+//;
- @mchannel = ();
- for (my $i=0;$i<int(@owg_fixed);$i++){
- $val = $linarr[5+6*$i];
- push(@mchannel,$val);
- }
- push(@month,[@mchannel]);
- }
- }
- }
- if( int(@month)<($cday-1) ){
- Log3 $name,3, "OWCOUNT: warning, found only ".int(@month)." lines in logfile $lf of LogM";
- }
- } else {
- return "cannot open logfile of LogM";
- }
-
- #-- sum and average
- for (my $i=0;$i<int(@owg_fixed);$i++){
- $total = 0.0;
- #-- summing only if mode daily (means daily reset !)
- $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$i]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$i]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- if( $daily==1){
- for (my $j=0;$j<int(@month);$j++){
- $total += $month[$j][$i];
- }
- }
- #-- add data from current day also for non-summed mode
- $total = int($total*100)/100;
- $total2 = int(100*($total+$hash->{READINGS}{$owg_channel[$i]}{VAL}))/100;
- #-- number of days so far, including the present day
- my $deltim = int(@month)+($chour+$cmin/60.0 + $csec/3600.0)/24.0;
- my $av = $deltim>0 ? int(100*$total2/$deltim)/100 : -1;
- #-- output format
- push(@month2,[($total,$total2,$av)]);
- }
- return @month2;
- }
- ########################################################################################
- #
- # OWCOUNT_GetYear Read yearly data from a file
- #
- # Parameter hash
- #
- # Returns total value up to last month including this month and average including this day
- #
- ########################################################################################
- sub OWCOUNT_GetYear($) {
- my ($hash) = @_;
- my $name = $hash->{NAME};
- my $regexp = ".*$name.*";
- my $val;
- my @year = ();
- my @year2 = ();
- my @mchannel;
- my @linarr;
- my $month;
- my $line;
- my ($total,$total2,$daily,$deltim,$av);
- #-- Check current logfile
- my $ln = $attr{$name}{"LogY"};
- if( !(defined($ln))){
- return "attribute LogY is missing";
- }
-
- #-- get channel names
- OWCOUNT_ChannelNames($hash);
-
- #-- current date
- my ($csec,$cmin,$chour,$cday,$cmonth,$cyear,$cwday,$cyday,$cisdst) = localtime(time);
-
- my $lf = $defs{$ln}{currentlogfile};
- if( !(defined($lf))){
- return "logfile of LogY is missing";
- }
-
- my $ret = open(OWXFILE, "< $lf" );
- if( $ret) {
- while( <OWXFILE> ){
- #-- line looks as
- # 2013-05-31_23:57:57 DG.CT1 month: M05 W: 42.2 kWh Wy: 84.4 kWh B: 2287295.7 cts By: 2270341.0 cts
- $line = $_;
- chomp($line);
- if ( $line =~ m/$regexp/i){
- @linarr = split(' ',$line);
- if( int(@linarr)==4+6*int(@owg_fixed) ){
- $month = $linarr[3];
- $month =~ s/M_+0+//;
- @mchannel = ();
- for (my $i=0;$i<int(@owg_fixed);$i++){
- $val = $linarr[5+6*$i];
- push(@mchannel,$val);
- }
- push(@year,[@mchannel]);
- }
- }
- }
- if( int(@year)<($cmonth-1) ){
- Log3 $name,3, "OWCOUNT: warning, found only ".int(@year)." lines in logfile $lf of LogY";
- }
- } else {
- return "cannot open logfile of LogY";
- }
-
-
- #-- sum and average
- my @month2 = OWCOUNT_GetMonth($hash);
- for (my $i=0;$i<int(@owg_fixed);$i++){
- $total = 0.0;
- $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$i]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$i]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- #-- sum previous months only in daily mode
- if( $daily==1){
- for (my $j=0;$j<int(@year);$j++){
- $total += $year[$j][$i];
- }
- }else{
- $total = $year[int(@year)-1][$i]
- if (int(@year)>0);
- };
- $total = int($total*100)/100;
- #-- data from this month is
- $total2 = int(100*($month2[$i]->[1]))/100;
- #-- add data from this month and previous months in daily mode
- $total2+=$total
- if( $daily==1 );
- #-- number of days so far, including the present day
- my $deltim = $cyday+($chour+$cmin/60.0 + $csec/3600.0)/24.0;
- my $av = $deltim>0 ? int(100*$total2/$deltim)/100 : -1;
- #-- output format
- push(@year2,[($total,$total2,$av)]);
- }
- return @year2;
- }
- #######################################################################################
- #
- # OWCOUNT_GetValues - Updates the reading from one device
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_GetValues($) {
- my $hash = shift;
-
- my $name = $hash->{NAME};
- my $model = $hash->{OW_MODEL};
- my $value = "";
- my $ret = "";
- my ($ret1,$ret2);
-
- #-- check if device needs to be initialized
- OWCOUNT_InitializeDevice($hash)
- if( $hash->{READINGS}{"state"}{VAL} eq "defined");
-
- #-- restart timer for updates
- RemoveInternalTimer($hash);
- InternalTimer(time()+$hash->{INTERVAL}, "OWCOUNT_GetValues", $hash, 0);
-
- #-- Get readings
- $ret1 = OWCOUNT_GetPage($hash,14,0);
- $ret2 = OWCOUNT_GetPage($hash,15,1);
-
- #-- process results
- $ret .= $ret1
- if( defined($ret1) );
- $ret .= $ret2
- if( defined($ret2) );
- if( $ret ne "" ){
- return "OWCOUNT: Could not get values from device $name, reason: ".$ret;
- }
- return undef;
- }
- #######################################################################################
- #
- # OWCOUNT_ParseMidnight - Read the stored midnight value
- #
- # Parameter hash = hash of device addressed
- # strval = data string
- # page = page number
- #
- ########################################################################################
- sub OWCOUNT_ParseMidnight($$$) {
- my ($hash,$strval,$page) = @_;
- #-- midnight value
- #-- new format
- if ( defined $strval and $strval =~ /^\d\d\d\d-\d\d-\d\d.*/ ) {
- my @data=split(' ',$strval);
- $strval = $data[2];
- }
- if ( defined $strval ) {
- #-- parse float from midnight
- $strval =~ s/[^-\d\.]+//g;
- $strval = 0.0 if($strval !~ /^-?\d+\.\d*$/);
- $strval = int($strval*100)/100;
- } else {
- $strval = 0.0;
- }
- $hash->{owg_midnight}->[$page-14] = $strval;
- }
- #######################################################################################
- #
- # OWCOUNT_Set - Set one value for device
- #
- # Parameter hash = hash of device addressed
- # a = argument array
- #
- ########################################################################################
- sub OWCOUNT_Set($@) {
- my ($hash, @a) = @_;
-
- my $key = $a[1];
- my $value = $a[2];
-
- #-- for the selector: which values are possible
- if (@a == 2){
- my $newkeys = join(" ", keys %sets);
- return $newkeys ;
- }
-
- #-- check syntax
- return "OWCOUNT: Set needs at least one parameter"
- if( int(@a)<3 );
- #-- check argument
- if( !defined($sets{$a[1]}) ){
- return "OWCOUNT: Set with unknown argument $a[1]";
- }
-
- #-- define vars
- my $ret = undef;
- my $page;
- my $data;
- my $name = $hash->{NAME};
- my $model = $hash->{OW_MODEL};
- my ($cname,@cnama,@channel);
-
- #-- set new timer interval
- if($key eq "interval") {
- # check value
- return "OWCOUNT: Set with short interval, must be > 1"
- if(int($value) < 1);
- # update timer
- $hash->{INTERVAL} = $value;
- RemoveInternalTimer($hash);
- InternalTimer(gettimeofday()+$hash->{INTERVAL}, "OWCOUNT_GetValues", $hash, 0);
- return undef;
- }
-
- #-- get channel names
- OWCOUNT_ChannelNames($hash);
-
- #-- set memory page/counter according to interface type
- my $interface= $hash->{IODev}->{TYPE};
-
- #-- check syntax for setting memory page 0..13
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
- if( $key eq "memory" ){
- return "OWCOUNT: Memory usage disabled"
- if( $nomemory==1 );
- return "OWCOUNT: Set needs parameter when writing memory: <page>"
- if( int(@a)<2 );
- $page=int($a[2]);
- if( ($page<0) || ($page>13) ){
- return "OWXCOUNT: Wrong memory page write attempted";
- }
- $data=$a[3];
- for( my $i=4;$i<int(@a);$i++){
- $data.=" ".$a[$i];
- }
- if( length($data) > 32 ){
- Log3 $name,3,"OWCOUNT: Memory data truncated to 32 characters";
- $data=substr($data,0,32);
- }elsif( length($data) < 32 ){
- for(my $i=length($data)-1;$i<32;$i++){
- $data.=" ";
- }
- }
- $ret = OWCOUNT_SetPage($hash,$page,$data);
- }
-
- #-- other commands are per channel
- if( ($key eq "midnight") || ($key eq "counter" )){
- return "OWCOUNT: Set $key needs parameter: <channel>"
- if( int(@a)<2 );
- #-- find out which channel we have
- if( ($a[2] eq $owg_channel[0]) || ($a[2] eq "A") ){
- $page=14;
- }elsif( ($a[2] eq $owg_channel[1]) || ($a[2] eq "B") ){
- $page=15;
- } else {
- return "OWCOUNT: Invalid counter address, must be A, B or defined channel name"
- }
- #-- mode normal or daily
- my $daily = 0;
- if( defined($attr{$name}{$owg_fixed[$page-14]."Mode"} )){
- if( $attr{$name}{$owg_fixed[$page-14]."Mode"} eq "daily"){
- $daily = 1;
- }
- }
- return "OWCOUNT: Set $key for channel $a[2] not possible, is not in daily mode"
- if( $daily==0 );
-
- my ($sec, $min, $hour, $day, $month, $year, $wday,$yday,$isdst) = localtime(time);
-
- if( $key eq "midnight" ){
- $data = sprintf("%4d-%02d-%02d midnight %7.2f",
- $year+1900,$month+1,$day,$a[3]);
- $ret = OWCOUNT_SetPage($hash,$page,$data);
- }
- #--
- if( $key eq "counter" ){
- my $midnew=($hash->{owg_val}->[$page-14] + $hash->{READINGS}{$owg_channel[$page-14]}{OFFSET})*
- $hash->{READINGS}{$owg_channel[$page-14]}{FACTOR} - $a[3];
- $data = sprintf("%4d-%02d-%02d midnight %7.2f",
- $year+1900,$month+1,$day,$midnew);
- Log3 $name,5,"OWCOUNT: old midnight vakue ".$hash->{owg_midnight}->[$page-14].", replaced by $midnew";
- $ret = OWCOUNT_SetPage($hash,$page,$data);
- }
- }
- #-- process results - we have to reread the device
- if( defined($ret) && ($ret ne "") ){
- return "OWCOUNT: Could not set device $name, reason: ".$ret;
- }
- OWCOUNT_GetValues($hash);
- Log3 $name,5, "OWCOUNT: Set $hash->{NAME} $key $value";
- }
- #######################################################################################
- #
- # OWCOUNT_SetPage - Set one value for device
- #
- # Parameter hash = hash of device addressed
- # page = page addressed
- # data = data
- #
- ########################################################################################
- sub OWCOUNT_SetPage ($$$) {
- my ($hash, $page, $data) = @_;
-
- #-- set memory page/counter according to interface type
- my $interface= $hash->{IODev}->{TYPE};
- my $name = $hash->{NAME};
- my $ret;
-
- #-- check if memory usage has been disabled
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
-
- if( $nomemory==0 ){
- #-- OWX interface
- if( $interface eq "OWX" ){
- $ret = OWXCOUNT_SetPage($hash,$page,$data);
- }elsif( $interface eq "OWX_ASYNC" ){
- eval {
- OWX_ASYNC_Schedule( $hash, OWXCOUNT_PT_SetPage($hash,$page,$data) );
- };
- $ret = GP_Catch($@) if $@;
- #-- OWFS interface
- }elsif( $interface eq "OWServer" ){
- $ret = OWFSCOUNT_SetPage($hash,$page,$data);
- #-- Unknown interface
- }else{
- return "OWCOUNT: SetPage with wrong IODev type $interface";
- }
-
- #-- process results
- if( defined($ret) && ($ret ne "") ){
- return "OWCOUNT: Could not set device $name, reason: ".$ret;
- }
- }else{
- if( $page==14 ){
- return OWCOUNT_store($hash,"OWCOUNT_".$name."_14.dat",$data);
- }elsif( $page==15 ){
- return OWCOUNT_store($hash,"OWCOUNT_".$name."_15.dat",$data);
- } else {
- return "OWCOUNT: file store with wrong page number";
- }
- }
- }
- ########################################################################################
- #
- # Store daily start value in a file
- #
- # Parameter hash, filename
- #
- ########################################################################################
- sub OWCOUNT_store($$$) {
- my ($hash,$filename,$data) = @_;
-
- my $name = $hash->{NAME};
- my $mp = AttrVal("global", "modpath", ".");
- my $ret = open(OWXFILE, "> $mp/FHEM/$filename" );
- if( $ret) {
- print OWXFILE $data;
- Log3 $name,1, "OWCOUNT_store: $name $data";
- close(OWXFILE);
- } else {
- Log3 $name,1,"OWCOUNT_store: Cannot open $filename for writing!";
- }
- return $ret;
- }
- ########################################################################################
- #
- # OWCOUNT_recall Recall daily start value from a file
- #
- # Parameter hash,filename
- #
- ########################################################################################
- sub OWCOUNT_recall($$) {
- my ($hash,$filename) = @_;
-
- my $name= $hash->{NAME};
-
- my $mp = AttrVal("global", "modpath", ".");
- my $ret = open(OWXFILE, "< $mp/FHEM/$filename" );
- if( $ret ){
- my $line = readline OWXFILE;
- close(OWXFILE);
- return $line;
- }
- Log3 $name,1, "OWCOUNT_recall: Cannot open $filename for reading, 2nd attempt";
- $ret = OWCOUNT_store($hash,$filename,0);
- if (!$ret){
- $ret = open(OWXFILE, "< $mp/FHEM/$filename" );
- if( $ret ){
- my $line = readline OWXFILE;
- close(OWXFILE);
- return $line;
- }
- Log3 $name,1, "OWCOUNT_recall: Cannot open $filename for reading - tried twice";
- return "error";
- }
- }
- ########################################################################################
- #
- # OWCOUNT_Undef - Implements UndefFn function
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWCOUNT_Undef ($) {
- my ($hash) = @_;
- delete($modules{OWCOUNT}{defptr}{$hash->{OW_ID}});
- RemoveInternalTimer($hash);
- return undef;
- }
- ########################################################################################
- #
- # The following subroutines in alphabetical order are only for a 1-Wire bus connected
- # via OWFS
- #
- # TODO: So far no automatic recognition of DS2423 / Emulator
- #
- # Prefix = OWFSCOUNT
- #
- ########################################################################################
- #
- # OWFSCOUNT_GetPage - Get page from device
- #
- # Parameter hash = hash of device addressed
- # page = page to be read
- # final= 1 if FormatValues is to be called
- #
- ########################################################################################
- sub OWFSCOUNT_GetPage($$$) {
- my ($hash,$page,$final) = @_;
-
- #-- ID of the device
- my $owx_add = substr($hash->{ROM_ID},0,15);
-
- #-- hash of the busmaster
- my $master = $hash->{IODev};
- my $name = $hash->{NAME};
-
- #-- reset presence
- $hash->{PRESENT} = 0;
-
- my $vval;
- my $strval;
-
- #=============== wrong value requested ===============================
- if( ($page<0) || ($page>15) ){
- return "wrong memory page requested";
- }
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
- #-- get values - or shoud we rather get the uncached ones ?
- if( $page == 14 || $page == 15 ) {
- $vval = OWServer_Read($master,"/$owx_add/counters.$owg_fixed[$page-14]");
- return "no return from OWServer for counter.$owg_fixed[$page-14]" unless defined $vval;
- return "empty return from OWServer for counter.$owg_fixed[$page-14]" if($vval eq "");
- if ($nomemory == 0) {
- $strval = OWServer_Read($master,"/$owx_add/pages/page.$page");
- return "no return from OWServer for page.$page" unless defined $strval;
- return "empty return from OWServer for page.$page" if($strval eq "");
- } else {
- $strval = OWCOUNT_recall($hash,"OWCOUNT_".$hash->{NAME}."_".$page.".dat");
- }
-
- $hash->{owg_val}->[$page-14] = $vval;
- $hash->{owg_str}->[$page] = defined $strval ? $strval : "";
- #-- midnight value
- OWCOUNT_ParseMidnight($hash,$strval,$page);
- }else {
- $strval = OWServer_Read($master,"/$owx_add/pages/page.".$page);
- return "no return from OWServer"
- if( !defined($strval) );
- return "empty return from OWServer"
- if( $strval eq "" );
- $hash->{owg_str}->[$page] = $strval;
- }
- #-- and now from raw to formatted values
- $hash->{PRESENT} = 1;
- if($final==1){
- my $value = OWCOUNT_FormatValues($hash);
- Log3 $name,5, $value;
- }
- return undef;
- }
- ########################################################################################
- #
- # OWFSCOUNT_SetPage - Set page in device
- #
- # Parameter hash = hash of device addressed
- #
- ########################################################################################
- sub OWFSCOUNT_SetPage($$$) {
- my ($hash,$page,$data) = @_;
-
- #-- ID of the device
- my $owx_add = substr($hash->{ROM_ID},0,15);
-
- #-- hash of the busmaster
- my $master = $hash->{IODev};
- my $name = $hash->{NAME};
-
- #=============== wrong page requested ===============================
- if( ($page<0) || ($page>15) ){
- return "wrong memory page write attempt";
- }
- #=============== midnight value =====================================
- if( ($page==14) || ($page==15) ){
- OWCOUNT_ParseMidnight($hash,$data,$page);
- }
- OWServer_Write($master, "/$owx_add/pages/page.".$page,$data );
- return undef
- }
- ########################################################################################
- #
- # The following subroutines in alphabetical order are only for a 1-Wire bus connected
- # directly to the FHEM server
- #
- # Prefix = OWXCOUNT
- #
- ########################################################################################
- #
- # OWXCOUNT_BinValues - Process reading from one device - translate binary into raw
- #
- # Parameter hash = hash of device addressed
- # context = mode for evaluating the binary data
- # proc = processing instruction, also passed to OWX_Read.
- # bitwise interpretation !!
- # if 0, nothing special
- # if 1 = bit 0, a reset will be performed not only before, but also after
- # the last operation in OWX_Read
- # if 2 = bit 1, the initial reset of the bus will be suppressed
- # if 8 = bit 3, the fillup of the data with 0xff will be suppressed
- # if 16= bit 4, the insertion will be at the top of the queue
- # owx_dev = ROM ID of slave device
- # crcpart = part of the data that needs to be part of the CRC check
- # numread = number of bytes to receive
- # res = result string
- #
- #
- #######################################################################################
- sub OWXCOUNT_BinValues($$$$$$$) {
- my ($hash, $context, $proc, $owx_dev, $crcpart, $numread, $res) = @_;
-
- #-- hash of the busmaster
- my $master = $hash->{IODev};
- my $name = $hash->{NAME};
- my @data=[];
- my $value;
- my $msg;
- OWX_WDBG($name,"OWCOUNT_BinValues called for device $name in context $context with ",$res)
- if( $main::owx_debug>2 );
-
- return undef unless (defined $context and $context =~ /^(get|set|check)page\.([\d]+)(\.final|)$/);
- my $cmd = $1;
- my $page = $2;
- my $final = $3;
- #=============== get memory + counter ===============================
- if ($cmd eq "get") {
- my (@data,$strval,$value);
- my $change = 0;
- @data=split(//,$res);
-
- #-- process results
- if(ord($data[17])<=0){
- #-- invalid data: do not die, but change memory flags
- if( $page > 13 ){
- $owg_memory[1]=0;
- }else{
- $owg_memory[0]=0;
- }
- $owg_memory[2]=1;
- $msg="memory data could not be read";
- }else{
- if( $page > 13 ){
- $owg_memory[1]=1;
- }else{
- $owg_memory[0]=1;
- }
- $owg_memory[2]=1;
- }
-
- if( int(@data) < 42){
- $msg="$name returns invalid data length, ".int(@data)." instead of 42 bytes";
- }elsif (OWX_CRC16($crcpart.substr($res,0,40),$data[40],$data[41]) == 0){
- $msg="$name returns invalid CRC, ".ord($data[40])." ".ord($data[41]);
- }
- OWX_WDBG($name,"OWXCOUNT_BinValues: ".$msg,"")
- if( $main::owx_debug>2 );
-
- #--
- my $nomemory = defined($attr{$name}{"nomemory"}) ? $attr{$name}{"nomemory"} : 0;
- if( $nomemory==0 ){
- #-- memory part, treated as string
- $strval=substr($res,0,32);
- #Log3 $name,5,"OWCOUNT: retrieved from memory for page $page ==> $strval";
- } else {
- $strval = OWCOUNT_recall($hash,"OWCOUNT_".$hash->{NAME}."_".$page.".dat");
- #Log3 $name,5,"OWCOUNT: retrieved from disk for page $page ==> $strval";
- }
- $hash->{owg_str}->[$page]= defined $strval ? $strval : "";
- #-- counter part
- if( ($page == 14) || ($page == 15) ){
- @data=split(//,substr($res,32));
- if ( ($data[4] | $data[5] | $data[6] | $data[7]) ne "\x00" ){
- OWX_WDBG($name, "device $name returns invalid data ".ord($data[4])." ".ord($data[5])." ".ord($data[6])." ".ord($data[7])," ");
- }
- #-- counter value
- $value = (ord($data[3])<<24) + (ord($data[2])<<16) +(ord($data[1])<<8) + ord($data[0]);
- $hash->{owg_val}->[$page-14] = $value;
- #-- midnight value
- #Log3 $name,1, "OWCOUNT_BinValues ParseMidnight: ".(defined $strval ? $strval : "undef");
- OWCOUNT_ParseMidnight($hash,$strval,$page);
- }
- #-- and now from raw to formatted values
- $hash->{PRESENT} = 1;
- if( $final ) {
- my $value = OWCOUNT_FormatValues($hash);
- }
- #=============== set memory ===============================
- #-- for setting a page we need a second step where the scratchpad is copied into memory
- }elsif (($cmd eq "set") && !$final ) {
- my $select="\x5A".substr($res,0,3);
- #### master slave context proc owx_dev data crcpart numread startread callback delay
- # 16 inserts at top of queue
- OWX_Qomplex($master, $hash, "setpage.$page.final", 16, $owx_dev, $select, 0, 6, 10, \&OWXCOUNT_BinValues, 0);
- #-- and a third step where this is finalized
- }elsif (($cmd eq "set") && $final ) {
- if( substr($res,4,1) ne "\xAA" ){
- if( $page > 13 ){
- $owg_memory[1]=0;
- }else{
- $owg_memory[0]=0;
- }
- }else{
- if( $page > 13){
- $owg_memory[1]=1;
- }else{
- $owg_memory[0]=1;
- }
- }
- #-- change applied
- $owg_memory[2]=1;
- }
- return undef;
- }
- ########################################################################################
- #
- # OWXCOUNT_GetPage - Get one memory page + counter from device
- #
- # Parameter hash = hash of device addressed
- # page = 0..15
- # final= 1 if FormatValues is to be called
- #
- ########################################################################################
- sub OWXCOUNT_GetPage($$$) {
- my ($hash,$page,$final) = @_;
-
- my ($select, $res, $res2, $res3, @data);
-
- #-- ID of the device, hash of the busmaster
- my $owx_dev = $hash->{ROM_ID};
- my $master = $hash->{IODev};
-
- #-- reset presence
- $hash->{PRESENT} = 0;
- #=============== wrong value requested ===============================
- if( ($page<0) || ($page>15) ){
- return "wrong memory page requested";
- }
- #=============== get memory + counter ===============================
- #-- issue the match ROM command \x55 and the read memory + counter command
- # \xA5 TA1 TA2 reading 40 data bytes and 2 CRC bytes
- my $ta2 = ($page*32) >> 8;
- my $ta1 = ($page*32) & 255;
- $select=sprintf("\xA5%c%c",$ta1,$ta2);
-
- my $context = "getpage.".$page.($final ? ".final" : "");
- #-- OLD OWX interface
- if( !$master->{ASYNCHRONOUS} ){
- #-- reset the bus
- OWX_Reset($master);
- #-- reading 9 + 3 + 40 data bytes (32 byte memory, 4 byte counter + 4 byte zeroes) and 2 CRC bytes = 54 bytes
- $res=OWX_Complex($master,$owx_dev,$select,42);
- if( $res eq 0 ){
- return "device $owx_dev not accessible in reading page $page";
- }
- #-- process results
- if( length($res) < 54 ) {
- #Log 1, "OWXCOUNT: warning, have received ".length($res)." bytes in first step";
- #-- read the data in a second step
- $res.=OWX_Complex($master,"","",0);
- #-- process results
- if( length($res) < 54 ) {
- #Log 1, "OWXCOUNT: warning, have received ".length($res)." bytes in second step";
- #-- read the data in a third step
- $res.=OWX_Complex($master,"","",0);
- }
- }
- #-- reset the bus (needed to stop receiving data ?)
- OWX_Reset($master);
- #-- for processing we need 45 bytes
- return "$owx_dev not accessible in reading"
- if( $res eq 0 );
- return "$owx_dev has returned invalid data"
- if( length($res)!=54);
- eval {
- OWXCOUNT_BinValues($hash,$context,0,$owx_dev,$select,45,substr($res,12));
- };
- return $@ ? $@ : undef;
- #-- NEW OWX interface
- }else{
- #### master slave context proc owx_dev data crcpart numread startread callback delay
- # 1 additional reset after last action
- OWX_Qomplex($master, $hash, $context, 1, $owx_dev, $select, $select, 45, 12, \&OWXCOUNT_BinValues, 0);
- return undef;
- }
- }
- ########################################################################################
- #
- # OWXCOUNT_SetPage - Set one memory page of device
- #
- # Parameter hash = hash of device addressed
- # page = 0..15
- # data = string to set into memory
- #
- ########################################################################################
- sub OWXCOUNT_SetPage($$$) {
- my ($hash,$page,$data) = @_;
-
- my ($select, $res, $res2, $res3);
-
- #-- ID of the device, hash of the busmaster
- my $owx_dev = $hash->{ROM_ID};
- my $master = $hash->{IODev};
-
- #=============== wrong page requested ===============================
- if( ($page<0) || ($page>15) ){
- return "wrong memory page write attempt";
- }
- #=============== midnight value =====================================
- if( ($page==14) || ($page==15) ){
- OWCOUNT_ParseMidnight($hash,$data,$page);
- }
- #=============== set memory =========================================
- #-- issue the match ROM command \x55 and the write scratchpad command
- # \x0F TA1 TA2 followed by the data
- my $ta2 = ($page*32) >> 8;
- my $ta1 = ($page*32) & 255;
- #Log 1, "OWXCOUNT: setting page Nr. $ta2 $ta1 $data";
- $select=sprintf("\x0F%c%c",$ta1,$ta2).$data;
- #-- OLD OWX interface
- if( !$master->{ASYNCHRONOUS} ){
- #-- reset the bus
- OWX_Reset($master);
- $res=OWX_Complex($master,$owx_dev,$select,0);
- if( $res eq 0 ){
- return "OWCOUNT: device $owx_dev not accessible in writing scratchpad";
- }
- #-- issue the match ROM command \x55 and the read scratchpad command
- # \xAA, receiving 2 address bytes, 1 status byte and scratchpad content
- $select = "\xAA";
- #-- reset the bus
- OWX_Reset($master);
- #-- reading 9 + 3 + up to 32 bytes
- # TODO: sometimes much less than 28
- $res=OWX_Complex($master,$owx_dev,$select,28);
- if( length($res) < 13 ){
- return "OWCOUNT: device $owx_dev not accessible in reading scratchpad";
- }
- #-- issue the match ROM command \x55 and the copy scratchpad command
- # \x5A followed by 3 byte authentication code obtained in previous read
- $select="\x5A".substr($res,10,3);
- #-- reset the bus
- OWX_Reset($master);
- $res=OWX_Complex($master,$owx_dev,$select,6);
- #-- process results
- if( $res eq 0 ){
- return "OWCOUNT: device $owx_dev not accessible for copying scratchpad";
- }
- if( substr($res,13,1) ne "\xAA" ){
- if( $page > 13){
- $owg_memory[1]=0;
- }else{
- $owg_memory[0]=0;
- }
- }else{
- if( $page > 13){
- $owg_memory[1]=1;
- }else{
- $owg_memory[0]=1;
- }
- }
- $owg_memory[2]=1;
- return undef;
- #-- NEW OWX interface
- }else{
- #### master slave context proc owx_dev data crcpart numread startread callback delay
- # 8 prevents from filling up with 0xFF
- OWX_Qomplex($master, $hash, undef, 8, $owx_dev, $select, $select, 35, 10, undef, 0);
- #-- The third step of copying the scratchpad into memory can be scheduled only when the authorization code has been received
- # will be done in the callback of the following line
- OWX_Qomplex($master, $hash, "setpage.".$page, 0, $owx_dev, "\xAA", 0, 37, 10, \&OWXCOUNT_BinValues, 0);
- }
- return undef;
- }
- ########################################################################################
- #
- # OWXCOUNT_PT_GetPage - Get one memory page + counter from device async
- #
- # Parameter hash = hash of device addressed
- # page = 0..15
- # final= 1 if FormatValues is to be called
- #
- ########################################################################################
- sub OWXCOUNT_PT_GetPage($$$) {
- my ($hash,$page,$final) = @_;
- return PT_THREAD(sub {
- my ($thread) = @_;
- #-- ID of the device, hash of the busmaster
- my $owx_dev = $hash->{ROM_ID};
- my $master = $hash->{IODev};
- PT_BEGIN($thread);
- #=============== wrong value requested ===============================
- if( ($page<0) || ($page>15) ){
- die("wrong memory page requested");
- }
- #=============== get memory + counter ===============================
- #-- issue the match ROM command \x55 and the read memory + counter command
- # \xA5 TA1 TA2 reading 40 data bytes and 2 CRC bytes
- my $ta2 = ($page*32) >> 8;
- my $ta1 = ($page*32) & 255;
- $thread->{'select'}=sprintf("\xA5%c%c",$ta1,$ta2);
-
- #-- reading 9 + 3 + 40 data bytes (32 byte memory, 4 byte counter + 4 byte zeroes) and 2 CRC bytes = 54 bytes
- $thread->{pt_execute} = OWX_ASYNC_PT_Execute($master,1,$owx_dev, $thread->{'select'}, 42 );
- PT_WAIT_THREAD($thread->{pt_execute});
- die $thread->{pt_execute}->PT_CAUSE() if ($thread->{pt_execute}->PT_STATE() == PT_ERROR);
- $thread->{response} = $thread->{pt_execute}->PT_RETVAL();
- #-- reset the bus (needed to stop receiving data ?)
- $thread->{pt_execute} = OWX_ASYNC_PT_Execute($master,1,undef,undef,undef);
- PT_WAIT_THREAD($thread->{pt_execute});
- die $thread->{pt_execute}->PT_CAUSE() if ($thread->{pt_execute}->PT_STATE() == PT_ERROR);
- if (my $ret = OWXCOUNT_BinValues($hash,"getpage.".$page.($final ? ".final" : ""),0,$owx_dev,$thread->{'select'},0,$thread->{response})) {
- die $ret;
- }
- PT_END;
- });
- }
- ########################################################################################
- #
- # OWXCOUNT_PT_SetPage - Set one memory page of device async
- #
- # Parameter hash = hash of device addressed
- # page = "alarm" or "status"
- #
- ########################################################################################
- sub OWXCOUNT_PT_SetPage($$$) {
- my ($hash,$page,$data) = @_;
-
- return PT_THREAD(sub {
- my ($thread) = @_;
- my ($res, $response);
- #-- ID of the device, hash of the busmaster
- my $owx_dev = $hash->{ROM_ID};
- my $master = $hash->{IODev};
- PT_BEGIN($thread);
- #=============== wrong page requested ===============================
- if( ($page<0) || ($page>15) ){
- PT_EXIT("wrong memory page write attempt");
- }
- #=============== midnight value =====================================
- if( ($page==14) || ($page==15) ){
- OWCOUNT_ParseMidnight($hash,$data,$page);
- }
- #=============== set memory =========================================
- #-- issue the match ROM command \x55 and the write scratchpad command
- # \x0F TA1 TA2 followed by the data
- my $ta2 = ($page*32) >> 8;
- my $ta1 = ($page*32) & 255;
- #Log 1, "OWXCOUNT: setting page Nr. $ta2 $ta1 $data";
- $thread->{'select'}=sprintf("\x0F%c%c",$ta1,$ta2).$data;
- #"setpage.1"
- $thread->{pt_execute} = OWX_ASYNC_PT_Execute($master,1,$owx_dev, $thread->{'select'}, 0 );
- PT_WAIT_THREAD($thread->{pt_execute});
- die $thread->{pt_execute}->PT_CAUSE() if ($thread->{pt_execute}->PT_STATE() == PT_ERROR);
- #-- issue the match ROM command \x55 and the read scratchpad command
- # \xAA, receiving 2 address bytes, 1 status byte and scratchpad content
- $thread->{'select'} = "\xAA";
- #-- reading 9 + 3 + up to 32 bytes
- # TODO: sometimes much less than 28
- #"setpage.2"
- $thread->{pt_execute} = OWX_ASYNC_PT_Execute($master,1,$owx_dev, $thread->{'select'}, 28 );
- PT_WAIT_THREAD($thread->{pt_execute});
- die $thread->{pt_execute}->PT_CAUSE() if ($thread->{pt_execute}->PT_STATE() == PT_ERROR);
- $res = $thread->{pt_execute}->PT_RETVAL();
- if( length($res) < 13 ){
- PT_EXIT("device $owx_dev not accessible in reading scratchpad");
- }
- #-- issue the match ROM command \x55 and the copy scratchpad command
- # \x5A followed by 3 byte authentication code obtained in previous read
- $thread->{'select'}="\x5A".substr($res,0,3);
- #-- first command, next 2 are address, then data
- #"setpage.3"
- $thread->{pt_execute} = OWX_ASYNC_PT_Execute($master,1,$owx_dev, $thread->{'select'}, 6 );
- PT_WAIT_THREAD($thread->{pt_execute});
- die $thread->{pt_execute}->PT_CAUSE() if ($thread->{pt_execute}->PT_STATE() == PT_ERROR);
- $res = $thread->{pt_execute}->PT_RETVAL();
- #TODO validate whether testing '0' is appropriate with async interface
- #-- process results
- if( $res eq 0 ){
- PT_EXIT("device $owx_dev error copying scratchpad");
- }
- PT_END;
- });
- }
- sub OWXCOUNT_PT_InitializeDevicePage($$$) {
- my ($hash,$page,$newdata) = @_;
- return PT_THREAD(sub {
- my ($thread) = @_;
- my $ret;
- PT_BEGIN($thread);
- $thread->{task} = OWXCOUNT_PT_GetPage($hash,$page,0);
- PT_WAIT_THREAD($thread->{task});
- $ret = $thread->{task}->PT_RETVAL();
- if ($ret) {
- PT_EXIT($ret);
- }
- $thread->{olddata} = $hash->{owg_str}->[14];
- $thread->{task} = OWXCOUNT_PT_SetPage($hash,$page,$newdata);
- PT_WAIT_THREAD($thread->{task});
- $ret = $thread->{task}->PT_RETVAL();
- if ($ret) {
- PT_EXIT($ret);
- }
- $thread->{task} = OWXCOUNT_PT_GetPage($hash,$page,0);
- PT_WAIT_THREAD($thread->{task});
- $ret = $thread->{task}->PT_RETVAL();
- if ($ret) {
- PT_EXIT($ret);
- }
- $thread->{task} = OWXCOUNT_PT_SetPage($hash,$page,$thread->{olddata});
- PT_WAIT_THREAD($thread->{task});
- $ret = $thread->{task}->PT_RETVAL();
- if ($ret) {
- PT_EXIT($ret);
- }
- PT_END;
- });
- }
- 1;
- =pod
- =begin html
- <a name="OWCOUNT"></a>
- <h3>OWCOUNT</h3>
- <p>FHEM module to commmunicate with 1-Wire Counter/RAM DS2423 or its emulation DS2423emu <br />
- <br />This 1-Wire module works with the OWX interface module or with the OWServer interface module
- (prerequisite: Add this module's name to the list of clients in OWServer).
- Please define an <a href="#OWX">OWX</a> device or <a href="#OWServer">OWServer</a> device first. <br/><p/>
- <br /><h4>Example</h4><br />
- <code>define OWC OWCOUNT 1D.CE780F000000 60</code>
- <br />
- <code>attr OWC AName energy|W</code>
- <br />
- <code>attr OWC AUnit kWh</code>
- <br />
- <code>attr OWC APeriod hour</code>
- <br />
- <code>attr OWC ARate power|P</code>
- <br />
- <code>attr OWX_AMode daily</code>
- <br />
- <br />
- <a name="OWCOUNTdefine"></a>
- <h4>Define</h4>
- <p>
- <code>define <name> OWCOUNT [<model>] <id> [<interval>]</code> or <br/>
- <code>define <name> OWCOUNT <fam>.<id> [<interval>]</code>
- <br /><br /> Define a 1-Wire counter.<br /><br /></p>
- <ul>
- <li>
- <code>[<model>]</code><br /> Defines the counter model (and thus 1-Wire family
- id), currently the following values are permitted: <ul>
- <li>model DS2423 with family id 1D (default if the model parameter is
- omitted)</li>
- <li>model DS2423enew with family id 1D - emulator, works like DS2423</li>
- <li>model DS2423eold with family id 1D - emulator, works like DS2423 except that the internal memory is not present</li>
- </ul>
- </li>
- <li>
- <code><fam></code>
- <br />2-character unique family id, see above
- </li>
- <li>
- <code><id></code>
- <br />12-character unique ROM id of the converter device without family id and CRC
- code </li>
- <li>
- <code><interval></code>
- <br />Measurement interval in seconds. The default is 300 seconds. </li>
- </ul>
- <br />
- <a name="OWCOUNTset"></a>
- <h4>Set</h4>
- <ul>
- <li><a name="owcount_interval">
- <code>set <name> interval <int></code></a><br /> Measurement
- interval in seconds. The default is 300 seconds. </li>
- <li><a name="owcount_memory">
- <code>set <name> memory <page> <string></code></a><br />Write 32 bytes to
- memory page 0..13 </li>
- <li><a name="owcount_midnight">
- <code>set <name> midnight <channel-name> <val></code></a><br />Write the
- day's starting value for counter <channel> (A, B or named channel, see
- below)</li>
- <li><a name="owcount_counter">
- <code>set <name> counter <channel-name> <val></code></a><br />Correct the midnight
- value such that counter <channel> (A, B or named channel, see
- below) displays value <val></li>
- </ul>
- <br />
- <a name="OWCOUNTget"></a>
- <h4>Get</h4>
- <ul>
- <li><a name="owcount_id">
- <code>get <name> id</code></a>
- <br /> Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC </li>
- <li><a name="owcount_present">
- <code>get <name> present</code>
- </a>
- <br /> Returns 1 if this 1-Wire device is present, otherwise 0. </li>
- <li><a name="owcount_interval2">
- <code>get <name> interval</code></a><br />Returns measurement interval in
- seconds. </li>
- <li><a name="owcount_memory2">
- <code>get <name> memory <page></code></a><br />Obtain 32 bytes from
- memory page 0..13 </li>
- <li><a name="owcount_midnight2">
- <code>get <name> midnight <channel-name></code></a><br />Obtain the
- day's starting value for counter <channel> (A, B or named channel, see
- below)</li>
- <li><a name="owcount_month">
- <code>get <name> month</code></a><br />Returns cumulated and averaged monthly value if mode=daily, otherwise last day's and averaged value </li>
- <li><a name="owcount_year">
- <code>get <name> year</code></a><br />Returns cumulated and averaged yearly value if mode=daily, otherwise last months's and averaged value </li>
- <li><a name="owcount_raw">
- <code>get <name> raw <channel-name></code></a><br />Obtain the
- current raw value for counter <channel> (A, B or named channel, see below)</li>
- <li><a name="owcount_counters">
- <code>get <name> counters</code></a><br />Obtain the current value both
- counters</li>
- </ul>
- <br />
- <a name="OWCOUNTattr"></a>
- <h4>Attributes</h4>
- <ul>
- <li><a name="owcount_logm"><code>attr <name> LogM
- <string></code></a>
- <br />device name (not file name) of monthly log file.</li>
- <li><a name="owcount_logy"><code>attr <name> LogY
- <string></code></a>
- <br />device name (not file name) of yearly log file.</li>
- <li><a name="owcount_interval2">
- <code>attr <name> interval <int></code></a>
- <br /> Measurement
- interval in seconds. The default is 300 seconds. </li>
- <li><a name="owcount_nomemory"><code>attr <name> nomemory
- 0|1</code></a>
- <br />when set to 1, midnight values will be stored in files instead of the internal memory.</li>
- </ul>
- <p>For each of the following attributes, the channel identification A,B may be used.</p>
- <ul>
- <li><a name="owcount_cname"><code>attr <name> <channel>Name
- <string>[|<string>]</code></a>
- <br />name for the channel [|short name used in state reading]. </li>
- <li><a name="owcount_cunit"><code>attr <name> <channel>Unit
- <string&</code></a>
- <br />unit of measurement used in state reading (default "cts", set to "none" for empty).</li>
- <li><a name="owcount_crate"><code>attr <name> <channel>Rate
- <string>[|<string>]</code></a>
- <br />name for the channel rate [|short name used in state reading]</li>
- <li><a name="owcount_coffset"><code>attr <name> <channel>Offset
- <float></code></a>
- <br />offset added to the reading in this channel. </li>
- <li><a name="owcount_cfactor"><code>attr <name> <channel>Factor
- <float></code></a>
- <br />factor multiplied to (reading+offset) in this channel. </li>
- <li><a name="owcount_cmode"><code>attr <name> <channel>Mode daily |
- normal</code></a>
- <br />determines whether counter is nulled at start of day or running continuously </li>
- <li><a name="owcount_cperiod"><code>attr <name> <channel>Period hour(default) | minute |
- second</code></a>
- <br />period for rate calculation </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
-
- =end html
- =cut
|