BeeClear Forums - Application Programming Interface (API)

Domoticz voorbeeld II (puur python)

Sun, 03 Mar 2019 08:32:18 +0000

Hieronder een 2e voorbeeld van een Python script voor Domoticz.
Als extra zal er nog een cron job moeten worden aangemaakt.
Met als regel:

*/5 * * * * python /home/pi/domoticz/scripts/beeclear.py

Sneller laten updaten naar domoticz heeft voor de logging geen zin, omdat dit niet wordt opgeslagen door Domoticz.

//////////////////Begin script//////////////////////////////////////////////////////

#! /usr/bin/python
# --------------------------------------------------
# PREPARATION & SETTINGS
# --------------------------------------------------
import urllib2
import urllib
import base64
import subprocess

domoticz_P1 = "44" # IDX for virtual P1-meter
domoticz_GAS = "43" # IDX for virtual GAS-meter

# --------------------------------------------------
# READING BEECLEAR
# --------------------------------------------------

host = '192.168.xxx.xxx'
username = 'beeclear'
password = 'energie'

class beeclear:
def __init__( self, hostname, user, passwd ):
self.hostname = hostname
self.user = user
self.passwd = passwd
self.cookie = None;
def connect( self ):
post_args = urllib.urlencode( { 'username': base64.b64encode(self.user), 'password': base64.b64encode(self.passwd) } )
url = 'http://' + self.hostname + '/bc_login?' + post_args;
req1 = urllib2.Request(url)
response = urllib2.urlopen(req1)
self.cookie = response.headers.get('Set-Cookie')
def send( self, command ):
url = 'http://' + self.hostname + '/' + command
req = urllib2.Request(url)
req.add_header('cookie', self.cookie)
f = urllib2.urlopen(req)
data = f.read()
f.close
return data

a = beeclear( host, username, password )
a.connect()

Str_beeclear = a.send ( 'bc_current' )
Str_beeclear = str(Str_beeclear)

# "d":1429103361, // d: date unix time (time of most recent meter telegram data)
# "ul":1061049, // ul: used low (KWH * 1000) (meter total used low)
# "uh":883337, // uh: used high (KWH * 1000) (meter total used high)
# "gl":123574, // gl: generated low (KWH * 1000) (meter total generated low)
# "gh":334551, // gh: generated high (KWH * 1000) (meter total generated high)
# "u":0.000, // u: current usage in KW (current active electricity usage)
# "g":1.934, // g: current generating in KW (current active electricity generating)
# "gas":1142889 } //gas: gas usage in cubicle meters m3 * 1000 (meter total used gas)

ul= Str_beeclear[Str_beeclear.find("ul")+4:Str_beeclear.find("uh")-2]
uh= Str_beeclear[Str_beeclear.find("uh")+4:Str_beeclear.find("gl")-2]
gl= Str_beeclear[Str_beeclear.find("gl")+4:Str_beeclear.find("gh")-2]
gh= Str_beeclear[Str_beeclear.find("gh")+4:Str_beeclear.find('"u"')-1]
u= Str_beeclear[Str_beeclear.find('"u"')+4:Str_beeclear.find('"g"')-1]
g= Str_beeclear[Str_beeclear.find('"g"')+4:Str_beeclear.find('"gas"')-1]
gas= Str_beeclear[Str_beeclear.find("gas")+22:Str_beeclear.find("time")-2]

# --------------------------------------------------
# CHANGE VARIABLES NAMES INTO DOMOTICZ LANGUAGE
# --------------------------------------------------

USAGE1 = ul
USAGE2 = uh
RETURN1 = gl
RETURN2 = gh
CONS = u
PROD = g
USAGE = gas

# --------------------------------------------------
# START OF UPLOAD TO DOMOTICZ
# --------------------------------------------------

#update P1 in Domoticz
httpresponse = urllib.urlopen("http://localhost:8080/json.htm?type=command¶m=udevice&idx=" + str(domoticz_P1) + "&nvalue=0&svalue=" + str(USAGE1) + ";" + str(USAGE2) + ";" + str(RETURN1) + ";" + str(RETURN2) + ";" + str(CONS) + ";" + str(PROD) )

#update Gas in Domoticz
httpresponse = urllib.urlopen("http://localhost:8080/json.htm?type=command¶m=udevice&idx=" + str(domoticz_GAS) + "&nvalue=0&svalue=" + str(USAGE) )

//////////////////Einde script//////////////////////////////////////////////////////

Voorbeeld API gebruik en Raspberry Pi

Fri, 21 Dec 2018 12:32:26 +0000

Hierbij een voorbeeld van het gebruik van de BeeClear API op een Raspberry Pi (maar werkt natuurlijk op elke web browser).

http://mxx.ovh/dAjsrAc1gn/IMG_2278.jpg

De temperatuur komt via een api van mijn Netatmo en de energie metrics komen van BeeClear. Dit alles op een eenvoudige webbrowser (Epiphany) omdat ik het scherm op de Raspberry Pi niet werkend krijg in combinatie met Chromium.

Dit alles is gemaakt met PHP een klein beetje Java-script. Ik kan het volledige script hier wel plaatsen maar dat werkt alleen als je ook een Netatmo hebt (voor de temperatuur).

Het gedeelte waarmee ik via PHP de data ophaal staat hieronder.

Deze php files worden included in de hoofdpagina en vanuit de hoofdpagina kunnen de variabelen dan gebruikt worden.

Bijvoorbeeld, $data_bc_current laat dus het huidige verbruik zien en $data_bc_getval_elek_today laat het totaal verbruik van vandaag tot en met nu zien.

De grafiekjes zijn wat lastiger en worden vanuit de hoofdpagina als volgt aangeroepen:

De parameters ($get_elek_graph en $get_gas_graph, die de inhoud van de grafiek bepalen) worden met de getoonde PHP scripts gegenereerd.

Het graph.php script staat hieronder ook weergegeven (3de script), overigens heb ik dit ergens van internet 'geleend' en iets aangepast.

Dat is zo'n beetje de opzet. Mocht je de scripts willen hebben dan kan ik die met alle plezier opsturen maar dan moet je zelf de Netatmo zooi er uit slopen (of je moet ook toevallig een Netatmo hebben).

Script 1, haal het huidige verbruik op.

date_default_timezone_set ("Europe/Amsterdam");

$url = 'http://beeclear.local/bc_current';
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
$data_bc_current = json_decode($json, TRUE);

?>

Scripts 2, haal het gebruik van vandaag per uur en het totaal op.

date_default_timezone_set ("Europe/Amsterdam");

$epoch=time();
$epoch=$epoch- ($epoch % 86400) - 3600;

$url = "http://beeclear.local/bc_getVal?type=gas&date=$epoch&duration=day&period=hour";
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
$data_bc_getval = json_decode($json, TRUE);

$gas_total=0;
$get_gas_graph="";
for($i=1; $i<24; $i++) {
$get_gas_graph.=$i."h=".$data_bc_getval['meetwaarden'][0]['val'][$i]['g']."&";
$gas_total+=$data_bc_getval['meetwaarden'][0]['val'][$i]['g'];
}

$data_bc_getval_gas_today = sprintf('%0.3f', $gas_total/1000);

$url = "http://beeclear.local/bc_getVal?type=elek&date=$epoch&duration=day&period=hour";
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
$data_bc_getval = json_decode($json, TRUE);

$elek_total=0;
$get_elek_graph="";
for($i=1; $i<24; $i++) {
$this_elek=$data_bc_getval['meetwaarden'][0]['val'][$i]['v']+$data_bc_getval['meetwaarden'][0]['val'][$i]['vl'];
$get_elek_graph.=$i."h=".$this_elek."&";
$elek_total+=$this_elek;
}

$data_bc_getval_elek_today = sprintf('%0.3f', $elek_total/1000);
#echo $data_bc_getval_elek_today;
?>

Script 3, grafiekjes maken

# ------- The graph values in the form of associative array

# values array is filles from other function
#$values= array( "1" => 100, "2" => 250, "3" => 300 );

$values = $_GET;

$img_width=220;
$img_height=120;
$margins=20;

# ---- Find the size of graph by substracting the size of borders
$graph_width=$img_width - $margins * 2;
$graph_height=$img_height - $margins * 2;
$img=imagecreate($img_width,$img_height);

$bar_width=5;
$total_bars=count($values);
$gap= ($graph_width- $total_bars * $bar_width ) / ($total_bars +1);

# ------- Define Colors ----------------
$bar_color=imagecolorallocate($img,40,255,0);
$xvalues_color=imagecolorallocate($img,255,255,255);
$background_color=imagecolorallocate($img,0,0,0);
$border_color=imagecolorallocate($img,0,0,0);
$line_color=imagecolorallocate($img,220,220,220);

# ------ Create the border around the graph ------

#imagefilledrectangle($img,1,1,$img_width-2,$img_height-2,$border_color);
imagefilledrectangle($img,0,0,$img_width,$img_height,$border_color);
imagefilledrectangle($img,$margins,$margins,$img_width-1-$margins,$img_height-1-$margins,$background_color);

# ------- Max value is required to adjust the scale -------
$max_value=(intval(max($values)/500)+1)*500;
$ratio= $graph_height/$max_value;

# -------- Create scale and draw horizontal lines --------
$horizontal_lines=4;
$horizontal_gap=$graph_height/$horizontal_lines;

for($i=1;$i<=$horizontal_lines;$i++){
$y=$img_height - $margins - $horizontal_gap * $i ;
imageline($img,$margins,$y,$img_width-$margins,$y,$line_color);
$v=intval($horizontal_gap * $i /$ratio);
imagestring($img,0,0,$y-5,$v,$xvalues_color);
}

# ----------- Draw the bars here ------
for($i=0;$i< $total_bars; $i++){
# ------ Extract key and value pair from the current pointer position
list($key,$value)=each($values);
$x1= $margins + $gap + $i * ($gap+$bar_width) ;
$x2= $x1 + $bar_width;
$y1=$margins +$graph_height- intval($value * $ratio) ;
$y2=$img_height-$margins;
#imagestring($img,0,$x1+3,$y1-10,$value,$bar_color);
if ( $i % 4 == 0 ) {
imagestring($img,0,$x1+3,$img_height-15,$key,$xvalues_color);
}
imagefilledrectangle($img,$x1,$y1,$x2,$y2,$bar_color);
}

header("Content-type:image/png");
imagepng($img);
?>

Domoticz voorbeeld

Tue, 05 Jun 2018 17:44:25 +0000

Beste BeeClear bezitter,

Hieronder een voorbeeld in python van een Domoticz gebruiker (Erik). Het mooiste is het als de code in
een versie managementsysteem geplaatst wordt zoals "git". Dan kunnen we naar de source verwijzen met een link.

////////////////////////////////////////////////begin script///////////////////////////////////////////////////////////////////////////

#! /usr/bin/python
import urllib2
import urllib
import base64
import subprocess

host = '192.168.0.20'
username = 'beeclear'
password = 'wachtwoord'

class beeclear:
def __init__( self, hostname, user, passwd ):
self.hostname = hostname
self.user = user
self.passwd = passwd
self.cookie = None;
def connect( self ):
post_args = urllib.urlencode( { 'username': base64.b64encode(self.user), 'password': base64.b64encode(self.passwd) } )
url = 'http://' + self.hostname + '/bc_login?' + post_args;
req1 = urllib2.Request(url)
response = urllib2.urlopen(req1)
self.cookie = response.headers.get('Set-Cookie')
def send( self, command ):
url = 'http://' + self.hostname + '/' + command
req = urllib2.Request(url)
req.add_header('cookie', self.cookie)
f = urllib2.urlopen(req)
data = f.read()
f.close
return data

a = beeclear( host, username, password )
a.connect()

Str_beeclear = a.send ( 'bc_current' )
Str_beeclear = str(Str_beeclear)

ul= Str_beeclear[Str_beeclear.find("ul")+4:Str_beeclear.find("uh")-2]
uh= Str_beeclear[Str_beeclear.find("uh")+4:Str_beeclear.find("gl")-2]
gl= Str_beeclear[Str_beeclear.find("gl")+4:Str_beeclear.find("gh")-2]
gh= Str_beeclear[Str_beeclear.find("gh")+4:Str_beeclear.find('"u"')-1]
gas= Str_beeclear[Str_beeclear.find("gas")+5:Str_beeclear.find("gd")-2]
Eu= Str_beeclear[Str_beeclear.find('"u"')+4:Str_beeclear.find('"g"')-1]
Eg= Str_beeclear[Str_beeclear.find('"g"')+4:Str_beeclear.find('"gas"')-1]

Netto= (int(gl)+int(gh)-int(ul)-int(uh))
str(Netto)

#update Netto in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=45&nvalue=0&svalue="'+str(Netto))
output = subprocess.check_output(['bash','-c', command])

#update Gas in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=53&nvalue=0&svalue="'+str(gas))
output = subprocess.check_output(['bash','-c', command])

#update E-export in high tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=60&nvalue=0&svalue="'+str(gh))
output = subprocess.check_output(['bash','-c', command])

#update E-import in high tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=61&nvalue=0&svalue="'+str(uh))
output = subprocess.check_output(['bash','-c', command])

#update E-import in low tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=59&nvalue=0&svalue="'+str(ul))
output = subprocess.check_output(['bash','-c', command])

#update E-export in low tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=58&nvalue=0&svalue="'+str(gl))
output = subprocess.check_output(['bash','-c', command])

#update E-netto in low tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=62&nvalue=0&svalue="'+str(Netto))
output = subprocess.check_output(['bash','-c', command])

#update E-netto in low tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=65&nvalue=0&svalue="'+str(Eu))
output = subprocess.check_output(['bash','-c', command])

#update E-netto in low tarrif in Domoticz
command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=66&nvalue=0&svalue="'+str(Eg))
output = subprocess.check_output(['bash','-c', command])

command = ('curl -i "http://Dom_user:wachtwoord@192.168.0.26:8080/json.htm?type=command¶m=udevice&idx=69&nvalue=0&svalue="'+str(Netto/1000))
output = subprocess.check_output(['bash','-c', command])

///////////////////////////////////////////////////////einde script////////////////////////////////////////////////////////////////////

Integratie met domotica (Athom Homey / Domoticz / e.a.)

Tue, 29 May 2018 15:02:28 +0000

Graag aandacht voor integratie van de API voor domotica-gebruikers.
Zie ook discussie op Homey forum
Met jullie kennis van de API is het wellicht (redelijk) eenvoudig een app te maken die bijvoorbeeld aansluit bij de Athom Homey.
Denk bijvoorbeeld aan een trigger die me meld over allerlei waarden (hoog/laag) welke worden geregistreerd door de Beeclear.
Of een apparaat wordt uit- of juist ingeschakeld bij het bereiken van een bepaalde waarde.