From 05b4a153b4cbd46ef47caefb940b062f253eae08 Mon Sep 17 00:00:00 2001
From: hcs-svn <hcs-svn@2b470e98-0d58-463d-a4d8-8e2adae1ed80>
Date: Sat, 6 Sep 2014 04:13:42 +0000
Subject: [PATCH] Added the new module 98_CustomReadings.pm

git-svn-id: svn://svn.code.sf.net/p/fhem/code/trunk@6503 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
 fhem/CHANGED                       |   1 +
 fhem/FHEM/98_CustomReadings.pm     | 201 +++++++++++++++++++++++++++++
 fhem/MAINTAINER.txt                |   1 +
 fhem/docs/commandref_frame.html    |   1 +
 fhem/docs/commandref_frame_DE.html |   1 +
 5 files changed, 205 insertions(+)
 create mode 100644 fhem/FHEM/98_CustomReadings.pm

diff --git a/fhem/CHANGED b/fhem/CHANGED
index 7d8960e0e..22f1865b6 100644
--- a/fhem/CHANGED
+++ b/fhem/CHANGED
@@ -1,5 +1,6 @@
 # Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
 # Do not insert empty lines here, update check depends on it.
+  - added:   98_CustomReadings.pm (maintainer: HCS)
   - change:  98_Text2Speech.pm: fix a problem with microseconds in time()
              by using mp3-templates or playing mp3 directly
   - feature: state definition and split attribute added to 66_ECMD, 
diff --git a/fhem/FHEM/98_CustomReadings.pm b/fhem/FHEM/98_CustomReadings.pm
new file mode 100644
index 000000000..e66593a29
--- /dev/null
+++ b/fhem/FHEM/98_CustomReadings.pm
@@ -0,0 +1,201 @@
+
+# $Id$
+#
+# TODO:
+
+package main;
+
+use strict;
+use warnings;
+use SetExtensions;
+
+sub
+CustomReadings_Initialize($)
+{
+  my ($hash) = @_;
+
+  $hash->{DefFn}         = "CustomReadings_Define";
+  $hash->{UndefFn}       = "CustomReadings_Undef";
+  $hash->{AttrList}      = "readingDefinitions " 
+                         . "interval "
+                         . "$readingFnAttributes";
+}
+
+sub
+CustomReadings_Define($$)
+{
+  my ($hash, $def) = @_;
+  my $name = $hash->{NAME};
+
+  CustomReadings_read($hash);
+  
+  return undef;
+}
+
+sub CustomReadings_read($)
+{
+  my ($hash) = @_;
+  my $name = $hash->{NAME};
+  
+  RemoveInternalTimer($hash);
+  InternalTimer(gettimeofday()+ AttrVal( $name, "interval", 5), "CustomReadings_read", $hash, 0);
+  
+  # Get the readingDefinitions and remove all newlines from the attribute
+  my $readingDefinitions = AttrVal( $name, "readingDefinitions", "");
+  $readingDefinitions =~ s/\n//g;
+    
+  my @definitionList = split(',', $readingDefinitions);
+  my @used = ("state");
+  
+  readingsBeginUpdate($hash);
+  foreach (@definitionList) {
+    my @definition = split(':', $_, 2);
+    push(@used, $definition[0]);
+    
+    my $value = eval($definition[1]);
+    if($value) {
+      $value =~ s/^\s+|\s+$//g;
+    }
+    else {
+      $value = "ERROR";
+    }
+    
+    readingsBulkUpdate($hash, $definition[0], $value);
+  }
+  
+  readingsEndUpdate($hash, 1);
+
+  foreach my $r (keys %{$hash->{READINGS}}) {
+    if (not $r ~~ @used   ) {
+      delete $hash->{READINGS}{$r};   
+    }
+  }
+  
+}
+
+
+sub
+CustomReadings_Undef($$)
+{
+  my ($hash, $arg) = @_;
+  my $name = $hash->{NAME};
+  
+  RemoveInternalTimer($hash);
+  
+  return undef;
+}
+
+
+1;
+
+=pod
+=begin html
+
+<a name="CustomReadings"></a>
+<h3>CustomReadings</h3>
+
+<ul>
+  <tr><td>
+  FHEM module to define own readings.
+  <br><br>
+  This module allows to define own readings. The readings can be defined in an attribute so that they can get changed without changing the code of the module.<br>
+  To use this module you should have some perl and linux knowledge<br>
+  The examples presuppose that you run FHEM on a linux machine like a Raspberry Pi or a Cubietruck.<br>
+  Note: the "bullshit" definition is an example to show what happens if you define bullshit :-)<br><br>
+  <u>Example (definition in fhem.cfg)</u>
+  <br><code>
+define myReadings CustomReadings<br>
+attr myReadings room 0-Test<br>
+attr myReadings interval 2<br>
+attr myReadings readingDefinitions hdd_temperature:qx(hddtemp /dev/sda 2>&1),<br>
+ac_powersupply_voltage:qx(cat /sys/class/power_supply/ac/voltage_now 2>&1) / 1000000,<br>
+ac_powersupply_current:qx(cat /sys/class/power_supply/ac/current_now 2>&1) / 1000000,<br>
+perl_version:$],<br>
+timezone:qx(cat /etc/timezone 2>&1),<br>
+kernel:qx(uname -r 2>&1),<br>
+device_name:$hash->{NAME},<br>
+bullshit: $hash->{bullshit},<br>
+fhem_backup_folder_size:qx(du -ch /opt/fhem/backup | grep total | cut -d 't' -f1 2>&1)<br>
+
+  <br>
+  <u>Resulting readings:</u><br>
+  <table>
+    <colgroup width="250" span="3"></colgroup>
+    <tr>
+      <td>ac_powersupply_current</td>
+      <td>0.236</td>
+      <td>2014-08-09 15:40:21<td>
+    </tr>
+    <tr>
+      <td>ac_powersupply_voltage</td>
+      <td>5.028</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>bullshit</td>
+      <td>ERROR</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>device_name</td>
+      <td>myReadings</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>fhem_backup_folder_size</td>
+      <td>20M</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>hdd_temperature</td>
+      <td>/dev/sda:  TS128GSSD320: 47°C</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>kernel</td>
+      <td>3.4.103-sun7i+</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>perl_version</td>
+      <td>5.014002</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+    <tr>
+      <td>timezone</td>
+      <td>Europe/Berlin</td>
+      <td>2014-08-09 15:40:21</td>
+    </tr>
+  </table>
+  </code>
+
+  <br>
+  <a name="CustomReadings_Define"></a>
+  <b>Define</b><br>
+  define &lt;name&gt; CustomReadings<br>
+  <br>
+  
+  <a name="CustomReadings_Readings"></a>
+  <b>Readings</b><br>
+  As defined
+  <br><br>
+
+  <a name="CustomReadings_Attr"></a>
+  <b>Attributes</b>
+  <ul>
+    <li>interval<br>
+    Refresh interval in seconds</li><br>
+    <li>readingDefinitions<br>
+    The definitions are separated by a comma. A definition consists of two parts, separated by a colon.<br>
+    The first part is the name of the reading and the second part the function.<br>
+    The function gets evaluated and must return a result.<br><br>
+    Example: <code>kernel:qx(uname -r 2>&1)</code><br>
+    Defines a reading with the name "kernel" and evaluates the linux function uname -r<br>
+    
+    </li>
+  </ul><br>
+</ul>
+
+
+=end html
+=cut
diff --git a/fhem/MAINTAINER.txt b/fhem/MAINTAINER.txt
index d62768ec5..fc849d443 100644
--- a/fhem/MAINTAINER.txt
+++ b/fhem/MAINTAINER.txt
@@ -236,6 +236,7 @@ FHEM/98_cloneDummy.pm        Joachim              http://forum.fhem.de Automatis
 FHEM/98_cmdalias.pm          rudolfkoenig         http://forum.fhem.de Automatisierung
 FHEM/98_configdb.pm          betateilchen         http://forum.fhem.de Sonstiges
 FHEM/98_copy.pm              justme1968           http://forum.fhem.de Sonstiges
+FHEM/98_CustomReadings.pm    HCS                  http://forum.fhem.de Unterstuetzende Dienste
 FHEM/98_dewpoint.pm          wherzig              http://forum.fhem.de Automatisierung
 FHEM/98_dummy.pm             rudolfkoenig         http://forum.fhem.de Automatisierung
 FHEM/98_fheminfo.pm          mfr69bs              http://forum.fhem.de Sonstiges
diff --git a/fhem/docs/commandref_frame.html b/fhem/docs/commandref_frame.html
index b8a083ed9..dd47a37d8 100644
--- a/fhem/docs/commandref_frame.html
+++ b/fhem/docs/commandref_frame.html
@@ -93,6 +93,7 @@
     <a href="#average">average</a> &nbsp;
     <a href="#Calendar">Calendar</a> &nbsp;
     <a href="#configDB">configDB</a> &nbsp;
+    <a href="#CustomReadings">CustomReadings</a> &nbsp;
     <a href="#DOIF">DOIF</a> &nbsp;
     <a href="#Dashboard">Dashboard</a> &nbsp;
     <a href="#DbLog">DbLog</a> &nbsp;
diff --git a/fhem/docs/commandref_frame_DE.html b/fhem/docs/commandref_frame_DE.html
index 9c8157465..c097bda16 100644
--- a/fhem/docs/commandref_frame_DE.html
+++ b/fhem/docs/commandref_frame_DE.html
@@ -40,6 +40,7 @@
       <a href="#configdb">configdb</a> &nbsp;
       <a href="#copy">copy</a> &nbsp;
       <a href="#createlog">createlog</a> &nbsp;
+      <a href="#CustomReadings">CustomReadings</a> &nbsp;
       <a href="#define">define</a> &nbsp;
       <a href="#delete">delete</a> &nbsp;
       <a href="#deleteattr">deleteattr</a> &nbsp;