From 9bdecee04379df808eda905a90249a1b9b8c282c Mon Sep 17 00:00:00 2001 From: pahenning <> Date: Sun, 25 Mar 2012 10:49:26 +0000 Subject: [PATCH] git-svn-id: https://svn.fhem.de/fhem/trunk@1384 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- fhem/contrib/1-Wire/21_OWLCD.pm | 966 ++++++++++++++++++++++++++++++++ 1 file changed, 966 insertions(+) create mode 100644 fhem/contrib/1-Wire/21_OWLCD.pm diff --git a/fhem/contrib/1-Wire/21_OWLCD.pm b/fhem/contrib/1-Wire/21_OWLCD.pm new file mode 100644 index 000000000..d5b1466d6 --- /dev/null +++ b/fhem/contrib/1-Wire/21_OWLCD.pm @@ -0,0 +1,966 @@ +######################################################################################## +# +# OWLCD.pm +# +# FHEM module to commmunicate with the 1-Wire LCD hardware +# +# Attention: This module may communicate with the OWX module, +# but currently not with the 1-Wire File System OWFS +# +# Prefixes for subroutines of this module: +# OW = General 1-Wire routines Peter Henning +# +# Prof. Dr. Peter A. Henning, 2012 +# +# Version 1.10 - March, 2012 +# +# Setup bus device in fhem.cfg as +# +# define OWLCD +# +# where may be replaced by any name string +# +# is a 12 character (6 byte) 1-Wire ROM ID +# without Family ID, e.g. A2D90D000800 +# +# get id => FAM_ID.ROM_ID.CRC +# get present => 1 if device present, 0 if not +# get gpio => current state of the gpio pins (15 = all off, 0 = all on) +# get counter => four values (16 Bit) of the gpio counter +# get version => firmware version of the LCD adapter +# +# Careful: Not ASCII ! strange Codepage +######################################################################################## +# +# 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; + +#-- Prototypes to make komodo happy +use vars qw{%attr %defs}; +use strict; +use warnings; +sub Log($$); + +#-- controller may be HD44780 or KS0073 +my $lcdcontroller = "KS0073"; +my $lcdlines = 4; +my $lcdchars = 20; + +#-- declare variables +my %gets = ( + "present" => "", + "id" => "", + "gpio" => "", + "counter" => "", + #"memory" => "", + "version" => "", + #"register" => "", + #"data" => "" +); +my %sets = ( + "icon" => "", + "line" => "", + "gpio" => "", + "backlight" => "", + "lcd" => "", + "reset" => "", + "test" => "" + +); +my %updates = (); + +######################################################################################## +# +# The following subroutines are independent of the bus interface +# +# Prefix = OWLCD +# +######################################################################################## +# +# OWLCD_Initialize +# +# Parameter hash = hash of device addressed +# +######################################################################################## + +sub OWLCD_Initialize ($) { + my ($hash) = @_; + + $hash->{DefFn} = "OWLCD_Define"; + $hash->{UndefFn} = "OWLCD_Undef"; + $hash->{GetFn} = "OWLCD_Get"; + $hash->{SetFn} = "OWLCD_Set"; + my $attlist = "IODev do_not_notify:0,1 showtime:0,1 loglevel:0,1,2,3,4,5 ". + ""; + $hash->{AttrList} = $attlist; +} + +######################################################################################### +# +# OWLCD_Define - Implements DefFn function +# +# Parameter hash = hash of device addressed, def = definition string +# +######################################################################################### + +sub OWLCD_Define ($$) { + my ($hash, $def) = @_; + + #-- define OWLCD + my @a = split("[ \t][ \t]*", $def); + + my ($name,$fam,$id,$crc,$ret); + + #-- default + $name = $a[0]; + $ret = ""; + + #-- check syntax + return "OWLCD: Wrong syntax, must be define OWLCD " + if(int(@a) !=3 ); + + #-- check id + if( $a[2] =~ m/^[0-9|a-f|A-F]{12}$/ ) { + $id = $a[2]; + } else { + return "OWLCD: $a[0] ID $a[2] invalid, specify a 12 digit value"; + } + + #-- 1-Wire ROM identifier in the form "FF.XXXXXXXXXXXX.YY" + # determine CRC Code - only if this is a direct interface + $crc = defined($hash->{IODev}->{INTERFACE}) ? sprintf("%02x",OWX_CRC("FF.".$id."00")) : "00"; + + #-- Define device internals + $hash->{ROM_ID} = "FF.".$id.$crc; + $hash->{OW_ID} = $id; + $hash->{OW_FAMILY} = "FF"; + $hash->{PRESENT} = 0; + + #-- Couple to I/O device + AssignIoPort($hash); + Log 3, "OWLCD: Warning, no 1-Wire I/O device found for $name." + if(!defined($hash->{IODev}->{NAME})); + + $modules{OWLCD}{defptr}{$id} = $hash; + + $hash->{STATE} = "Defined"; + Log 3, "OWLCD: Device $name defined."; + + #-- Initialization reading according to interface type + my $interface= $hash->{IODev}->{TYPE}; + + OWXLCD_InitializeDevice($hash); + #-- set backlight on + OWXLCD_SetFunction($hash,"bklon",0); + #-- erase all icons + OWXLCD_SetIcon($hash,0,0); + + $hash->{STATE} = "Initialized"; + return undef; +} + +######################################################################################## +# +# OWLCD_Get - Implements GetFn function +# +# Parameter hash = hash of device addressed, a = argument array +# +######################################################################################## + +sub OWLCD_Get($@) { + my ($hash, @a) = @_; + + my $reading = $a[1]; + my $name = $hash->{NAME}; + my $model = $hash->{OW_MODEL}; + my $value = undef; + my $ret = ""; + my $offset; + my $factor; + + #-- check syntax + return "OWLCD: Get argument is missing @a" + if(int(@a) != 2); + + #-- check argument + return "OWLCD: 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 "$a[0] $reading => $value"; + } + + #-- get present + if($a[1] eq "present") { + #-- hash of the busmaster + my $master = $hash->{IODev}; + $value = OWX_Verify($master,$hash->{ROM_ID}); + $hash->{PRESENT} = $value; + return "$a[0] $reading => $value"; + } + + #-- get gpio states + if($a[1] eq "gpio") { + $value = OWXLCD_Get($hash,"gpio",0); + return "$a[0] $reading => $value"; + } + + #-- get gpio counters + if($a[1] eq "counter") { + $value = OWXLCD_Get($hash,"counter",0); + return "$a[0] $reading => $value"; + } + + #-- get EEPROM counters + if($a[1] eq "memory") { + $value = OWXLCD_Get($hash,"memory",0); + return "$a[0] $reading => $value"; + } + + #-- get version + if($a[1] eq "version") { + $value = OWXLCD_Get($hash,"version",0); + return "$a[0] $reading => $value"; + } + + #-- get register + if($a[1] eq "register") { + $value = OWXLCD_Get($hash,"register",0); + return "$a[0] $reading => $value"; + } + + #-- get data + if($a[1] eq "data") { + $value = OWXLCD_Get($hash,"data",0); + return "$a[0] $reading => $value"; + } +} + +####################################################################################### +# +# OWLCD_Set - Set one value for device +# +# Parameter hash = hash of device addressed +# a = argument array +# +######################################################################################## + +sub OWLCD_Set($@) { + my ($hash, @a) = @_; + + my $key = $a[1]; + my $value = $a[2]; + my ($line,$icon,$i); + + #-- for the selector: which values are possible + return join(" ", keys %sets) + if ( (@a == 2) && !(($key eq "reset") || ($key eq "test")) ); + + #-- check argument + if( !defined($sets{$a[1]}) ){ + return "OWLCD: Set with unknown argument $a[1]"; + } + + #-- check syntax for setting line + if( $key eq "line" ){ + return "OWLCD: Set needs two parameters when setting line value: <#line> " + if( int(@a)<3 ); + $line = ($a[2] =~ m/\d/) ? $a[2] : 0; + $value = $a[3]; + for( $i=4; $i< int(@a); $i++){ + $value .= " ".$a[$i]; + } + #-- check syntax for setting icon + } elsif ( $key eq "icon" ){ + if( ($a[2] ne "0") && ($a[2] ne "none") ){ + return "OWLCD: Set needs two parameters when setting icon value: <#icon> on/off/blink (resp. 0..5/off/blink for #16)" + if( (int(@a)!=4) ); + $icon = ($a[2] =~ m/\d\d?/) ? $a[2] : 0; + $value = $a[3]; + } else { + return "OWLCD: Set needs only one parameter when resetting icons" + if( (int(@a)!=3) ); + $icon = 0; + $value = "OFF"; + } + #-- check syntax for reset and test + } elsif ( ($key eq "reset") || ($key eq "test") ){ + return "OWLCD: Set needs no parameters when setting $key value" + if( int(@a)!=2 ); + #-- other syntax + } else { + return "OWLCD: Set needs one parameter when setting $key value" + if( int(@a)!=3 ); + } + + #-- define vars + my $name = $hash->{NAME}; + my $model = $hash->{OW_MODEL}; + + #-- set gpio ports from all off = to all on = 7 + if($key eq "gpio") { + #-- check value and write to device + return "OWLCD: Set with wrong value for gpio port, must be 0 <= gpio <= 7" + if( ! ((int($value) > 0) && (int($value) < 7)) ); + OWXLCD_SetFunction($hash, "gpio", int($value)); + return undef; + } + + #-- set LCD ON or OFF + if($key eq "lcd") { + #-- check value and write to device + if( uc($value) eq "ON"){ + OWXLCD_SetFunction($hash, "lcdon", 0); + }elsif( uc($value) eq "OFF" ){ + OWXLCD_SetFunction($hash, "lcdoff", 0); + } else { + return "OWLCD: Set with wrong value for lcd, must be on/off" + } + return undef; + } + + #-- set LCD Backlight ON or OFF + if($key eq "backlight") { + #-- check value and write to device + if( uc($value) eq "ON"){ + OWXLCD_SetFunction($hash, "bklon", 0); + }elsif( uc($value) eq "OFF" ){ + OWXLCD_SetFunction($hash, "bkloff", 0); + } else { + return "OWLCD: Set with wrong value for backlight, must be on/off" + } + return undef; + } + + #-- reset + if($key eq "reset") { + OWXLCD_SetFunction($hash,"reset",0); + OWXLCD_SetIcon($hash,0,0); + return undef; + } + + #-- set icon + if($key eq "icon") { + return "OWLCD: Wrong icon type, choose 0..16" + if( ( 0 > $icon ) || ($icon > 16) ); + #-- check value and write to device + if( $icon == 16 ){ + if( uc($value) eq "OFF" ){ + OWXLCD_SetIcon($hash, 16, 0); + }elsif( uc($value) eq "BLINK" ){ + OWXLCD_SetIcon($hash, 16, 6); + }elsif( ((int($value) > 0) && (int($value) < 6)) ){ + OWXLCD_SetIcon($hash, 16, int($value)); + } else { + return "OWLCD: Set with wrong value for icon #16, must be 0..5/off/blink" + } + }else{ + if( uc($value) eq "OFF"){ + OWXLCD_SetIcon($hash, $icon, 0); + }elsif( uc($value) eq "ON" ){ + OWXLCD_SetIcon($hash, $icon, 1); + }elsif( uc($value) eq "BLINK" ){ + OWXLCD_SetIcon($hash, $icon, 2); + } else { + return "OWLCD: Set with wrong value for icon $icon, must be on/off/blink" + } + } + return undef; + } + + #-- set a single LCD line + if($key eq "line") { + return "OWLCD: Wrong line number, choose 0..".$lcdlines + if( ( 0 > $line ) || ($line > ($lcdlines-1)) ); + return "OWLCD: Wrong line length, must be < ".$lcdchars + if( length($value) > $lcdchars ); + #-- check value and write to device + OWXLCD_SetLine($hash,$line,$value); + return undef; + } + + #-- start test + if($key eq "test") { + OWXLCD_SetLine($hash,0,"Hallo Welt"); + OWXLCD_SetLine($hash,1,"Mary had a big lamb"); + OWXLCD_SetLine($hash,2,"Solar 4.322 kW "); + OWXLCD_SetLine($hash,3,"\x5B\x5C\x5E\x7B\x7C\x7E\xBE"); + return undef; + } +} + +######################################################################################## +# +# OWLCD_Undef - Implements UndefFn function +# +# Parameter hash = hash of device addressed +# +######################################################################################## + +sub OWLCD_Undef ($) { + my ($hash) = @_; + delete($modules{OWLCD}{defptr}{$hash->{OW_ID}}); + RemoveInternalTimer($hash); + return undef; +} + +######################################################################################## +# +# OWXLCD_Byte - write a single byte to the LCD device +# +# Parameter hash = hash of device addressed +# cmd = register or data +# byte = byte +# +######################################################################################## + +sub OWXLCD_Byte($$$) { + + my ($hash,$cmd,$byte) = @_; + + my ($select, $select2, $res, $res2, $res3, @data); + + #-- ID of the device + my $owx_dev = $hash->{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + my ($i,$j,$k); + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + + #-- issue the match ROM command \x55 + $select = sprintf("\x55%c%c%c%c%c%c%c%c", + @owx_ROM_ID); + #=============== write to LCD register =============================== + if ( $cmd eq "register" ) { + #-- issue the read LCD register command \x10 + $select .= sprintf("\x10%c",$byte); + #=============== write to LCD data =============================== + }elsif ( $cmd eq "data" ) { + #-- issue the read LCD data command \x12 + $select .= sprintf("\x12%c",$byte); + #=============== wrong value requested =============================== + } else { + return "OWXLCD: Wrong byte write attempt"; + } + + #-- write to device + OWX_Reset($master); + $res=OWX_Block($master,$select); + #-- process results + if( $res eq 0 ){ + return "OWLCD: Device $owx_dev not accessible for writing a byte"; + } + + return undef; +} + +######################################################################################## +# +# OWXLCD_Get - get values from the LCD device +# +# Parameter hash = hash of device addressed +# cmd = command string +# page = memory page address +# +######################################################################################## + +sub OWXLCD_Get($$$) { + + my ($hash,$cmd,$value) = @_; + + my ($select, $select2, $len, $addr, $res, $res2, $res3, @data); + + #-- ID of the device + my $owx_dev = $hash->{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + my ($i,$j,$k); + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + + #-- issue the match ROM command \x55 + $select = sprintf("\x55%c%c%c%c%c%c%c%c", + @owx_ROM_ID); + #-- issue the match ROM command \x55 and the read scratchpad command \xBE + $select2 = $select."\xBE"; + #=============== fill scratch with gpio ports =============================== + if ( $cmd eq "gpio" ) { + #-- issue the read GPIO command \x22 (1 byte) + $select .= "\x22"; + $len = 1; + #=============== fill scratch with gpio counters =============================== + }elsif ( $cmd eq "counter" ) { + #-- issue the read counter command \x23 (8 bytes) + $select .= "\x23"; + $len = 8; + #=============== fill scratch with EEPROM =============================== + #}elsif ( $cmd eq "memory" ) { + # #-- issue the read EEPROM command \x37 + # $len=16; + # $select .= "\x37"; + #=============== fill scratch with version =============================== + }elsif ( $cmd eq "version" ) { + #-- issue the read version command \x41 + $select .= "\x41"; + $len = 16; + #=============== fill scratch with LCD register =============================== + #}elsif ( $cmd eq "register" ) { + # #-- issue the read LCD register command \x11 + # $select .= "\x11"; + # $len = 16; + #=============== fill scratch with LCD data =============================== + #}elsif ( $cmd eq "data" ) { + # #-- issue the read LCD data command \x13 + # $addr = 0; + # $len = 16; + # #$select .= sprintf("\x13%c",$addr); + # $select .= "\x13\x00\x10"; + #=============== wrong value requested =============================== + } else { + return "OWXLCD: Wrong get attempt"; + } + #-- write to device + OWX_Reset($master); + $res=OWX_Block($master,$select); + #-- process results + if( $res eq 0 ){ + return "OWLCD: Device $owx_dev not accessible for reading"; + } + + #-- sleeping for some time + #select(undef,undef,undef,0.5); + + #-- fill according to expected length + for($i=0;$i<$len;$i++){ + $select2 .= "\xFF"; + } + #-- write to device + OWX_Reset($master); + $res=OWX_Block($master,$select2); + #-- process results + if( $res eq 0 ){ + return "OWLCD: Device $owx_dev not accessible for reading in 2nd step"; + } + + #-- process results (10 byes or more have been sent) + $res = substr($res,10); + #my $ress = "OWXLCD: Answer was "; + # for($i=0;$i{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + + #-- supposedly we do not need to do anything with a HD44780 + if( $lcdcontroller eq "HD44780"){ + return undef; + #-- need some additional sequence for KS0073 + }elsif ( $lcdcontroller eq "KS0073"){ + + #-- Function Set: 4 bit data size, RE => 0 = \x20 + #OWXLCD_Byte($hash,"register",32); + + #-- Entry Mode Set: cursor auto increment = \x06 + #OWXLCD_Byte($hash,"register",6); + + #-- Function Set: 4 bit data size, RE => 1, blink Enable = \x26 + OWXLCD_Byte($hash,"register",38); + + #-- Ext. Function Set: 4 line mode = \x09 + OWXLCD_Byte($hash,"register",9); + + #-- Function Set: 4 bit data size, RE => 0 = \x20 + OWXLCD_Byte($hash,"register",32); + + #-- Display ON/OFF: display on, cursor off, blink off = \x0C + OWXLCD_Byte($hash,"register",12); + + #-- Clear Display + OWXLCD_Byte($hash,"register",1); + + return undef; + #-- or else + } else { + return "OWXLCD: Wrong LCD controller type"; + } + +} + +######################################################################################## +# +# OWXLCD_SetFunction - write state and values of the LCD device +# +# Parameter hash = hash of device addressed +# cmd = command string +# value = data value +# +######################################################################################## + +sub OWXLCD_SetFunction($$$) { + + my ($hash,$cmd,$value) = @_; + + my ($select, $res, $res2, $res3, @data); + + #-- ID of the device + my $owx_dev = $hash->{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + my ($i,$j,$k); + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + #-- issue the match ROM command \x55 + $select=sprintf("\x55%c%c%c%c%c%c%c%c",@owx_ROM_ID); + + #=============== set gpio ports =============================== + if ( $cmd eq "gpio" ) { + #-- issue the write GPIO command + # \x21 followed by the data value (= integer 0 - 7) + $select .= sprintf("\x21%c",$value); + #=============== switch LCD on =============================== + }elsif ( $cmd eq "lcdon" ) { + #-- issue the lcd on cmd + $select .= "\x03"; + #=============== switch LCD off =============================== + }elsif ( $cmd eq "lcdoff" ) { + #-- issue the lcd off cmd + $select .= "\x05"; + #=============== switch LCD backlight on =============================== + }elsif ( $cmd eq "bklon" ) { + #-- issue the backlight on cmd + $select .= "\x08"; + #=============== switch LCD backlight off =============================== + }elsif ( $cmd eq "bkloff" ) { + #-- issue the backlight off cmd + $select .= "\x07"; + #=============== switch LCD backlight off =============================== + }elsif ( $cmd eq "reset" ) { + #-- issue the clear LCD command + $select .= "\x49"; + #=============== wrong write attempt =============================== + } else { + return "OWXLCD: Wrong function selected"; + } + + #-- write to device + OWX_Reset($master); + $res=OWX_Block($master,$select); + #-- process results + if( $res eq 0 ){ + return "OWLCD: Device $owx_dev not accessible for writing"; + } + + return undef; +} + +######################################################################################## +# +# OWXLCD_SetIcon - set one of the icons +# +# Parameter hash = hash of device addressed +# icon = address of the icon used = 0,1 .. 16 (0 = all off) +# value = data value: 0 = off, 1 = on, 2 = blink +# for battery icon 16: 0 = off, 1 = empty ... 5 = full, 6 = empty blink +# +######################################################################################## + +sub OWXLCD_SetIcon($$$) { + my ($hash,$icon,$value) = @_; + + my ($i,$data,$select, $res); + + #-- ID of the device + my $owx_dev = $hash->{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + + #-- only for KS0073 + if ( $lcdcontroller eq "KS0073"){ + + #-- write 16 zeros to erase all icons + if( $icon == 0){ + #-- 4 bit data size, RE => 1, blink Enable = \x26 + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x10\x26",@owx_ROM_ID); + OWX_Reset($master); + $res=OWX_Block($master,$select); + + #-- SEGRAM addres to 0 = \x40, + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x10\x40",@owx_ROM_ID); + #-- write 16 zeros to scratchpad + $select .= "\x4E\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"; + OWX_Reset($master); + $res=OWX_Block($master,$select); + + #-- issue the copy scratchpad to LCD command \x48 + $select=sprintf("\x55%c%c%c%c%c%c%c%c\x48",@owx_ROM_ID); + OWX_Reset($master); + $res=OWX_Block($master,$select); + } else { + #-- determine data value + if( int($icon) != 16 ){ + if( $value == 0 ){ + $data = 0; + } elsif ( $value == 1) { + $data = 16; + } elsif ( $value == 2) { + $data = 80; + } else { + return "OWXLCD: Wrong data value $value for icon $icon"; + } + } else { + if( $value == 0 ){ + $data = 0; + } elsif ( $value == 1) { + $data = 16; + } elsif ( $value == 2) { + $data = 24; + } elsif ( $value == 3) { + $data = 28; + } elsif ( $value == 4) { + $data = 30; + } elsif ( $value == 5) { + $data = 31; + } elsif ( $value == 6) { + $data = 80; + } else { + return "OWXLCD: Wrong data value $value for icon $icon"; + } + } + #-- 4 bit data size, RE => 1, blink Enable = \x26 + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x10\x26",@owx_ROM_ID); + OWX_Reset($master); + $res=OWX_Block($master,$select); + + #-- SEGRAM addres to 0 = \x40 + icon address + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x10%c",@owx_ROM_ID,63+$icon); + OWX_Reset($master); + $res=OWX_Block($master,$select); + + #-- data + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x12%c",@owx_ROM_ID,$data); + OWX_Reset($master); + $res=OWX_Block($master,$select); + } + #-- return to normal state + $select = sprintf("\x55%c%c%c%c%c%c%c%c\x10\x20",@owx_ROM_ID); + OWX_Reset($master); + $res=OWX_Block($master,$select); + #-- or else + } else { + return "OWXLCD: Wrong LCD controller type"; + } +} + +######################################################################################## +# +# OWXLCD_SetLine - set one of the display lines +# +# Parameter hash = hash of device addressed +# line = line number (0..3) +# msg = data string to be written +# +######################################################################################## + +sub OWXLCD_SetLine($$$) { + + my ($hash,$line,$msg) = @_; + + my ($select, $res, $res2, $res3, $i, $msgA, $msgB); + $res2 = ""; + $line = int($line); + $msg = defined($msg) ? $msg : ""; + #-- replace umlaut chars for special codepage + $msg =~ s/ä/\x7B/g; + $msg =~ s/ö/\x7C/g; + $msg =~ s/ü/\x7E/g; + $msg =~ s/Ä/\x5B/g; + $msg =~ s/Ö/\x5C/g; + $msg =~ s/Ü/\x5E/g; + $msg =~ s/ß/\xBE/g; + + #-- ID of the device + my $owx_dev = $hash->{ROM_ID}; + my $owx_rnf = substr($owx_dev,3,12); + my $owx_f = substr($owx_dev,0,2); + + #-- hash of the busmaster + my $master = $hash->{IODev}; + + #-- 8 byte 1-Wire device address + my @owx_ROM_ID =(0,0,0,0 ,0,0,0,0); + #-- from search string to byte id + my $devs=$owx_dev; + $devs=~s/\.//g; + for($i=0;$i<8;$i++){ + $owx_ROM_ID[$i]=hex(substr($devs,2*$i,2)); + } + + #-- split if longer than 16 bytes, fill each with blanks + if( length($msg) > 16 ) { + $msgA = substr($msg,0,16); + $msgB = substr($msg,16,length($msg)-16); + for($i = 0;$i<32-length($msg);$i++){ + $msgB .= "\x20"; + } + } else { + $msgA = $msg; + for($i = 0;$i<16-length($msg);$i++){ + $msgA .= "\x20"; + } + $msgB = undef; + } + + #-- issue the match ROM command \x55 and the write scratchpad command \x4E + # followed by LCD page address and the text + $select=sprintf("\x55%c%c%c%c%c%c%c%c\x4E\%c",@owx_ROM_ID,$line*32).$msgA; + OWX_Reset($master); + $res=OWX_Block($master,$select); + + #-- issue the copy scratchpad to LCD command \x48 + $select=sprintf("\x55%c%c%c%c%c%c%c%c\x48",@owx_ROM_ID); + OWX_Reset($master); + $res3=OWX_Block($master,$select); + + #-- if second string available: + if( defined($msgB) ){ + #-- issue the match ROM command \x55 and the write scratchpad command \x4E + # followed by LCD page address and the text + $select=sprintf("\x55%c%c%c%c%c%c%c%c\x4E\%c",@owx_ROM_ID,$line*32+16).$msgB; + OWX_Reset($master); + $res2=OWX_Block($master,$select); + + #-- issue the copy scratchpad to LCD command \x48 + $select=sprintf("\x55%c%c%c%c%c%c%c%c\x48",@owx_ROM_ID); + OWX_Reset($master); + $res3=OWX_Block($master,$select); + } + + #-- process results + if( ($res eq 0) || ($res2 eq 0) ){ + return "OWLCD: Device $owx_dev not accessible for writing"; + } + + return undef; + +} + +1;