52_I2C_MCP23008.pm 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703
  1. ##############################################################################
  2. # $Id: 52_I2C_MCP23008.pm 13602 2017-03-05 01:39:01Z klausw $
  3. ##############################################################################
  4. # Modul for I2C GPIO Extender MCP23008
  5. #
  6. # contributed by Klaus Wittstock (2014) email: klauswittstock bei gmail
  7. ##############################################################################
  8. package main;
  9. use strict;
  10. use warnings;
  11. use SetExtensions;
  12. use Scalar::Util qw(looks_like_number);
  13. my %Registers = (
  14. 'IODIRA' => 0x00, #1 = input; 0 = output (default 1)
  15. 'IODIRB' => 0x00,
  16. 'IPOLA' => 0x01, #1 inverts logic (default 0)
  17. 'IPOLB' => 0x01,
  18. 'GPINTENA' => 0x02, #1 enables the pin for interrupt-on-change (default 0)
  19. 'GPINTENB' => 0x02,
  20. 'DEFVALA' => 0x03, #The default comparison value for interrupt (opposite value will caues an interrupt) (default 0)
  21. 'DEFVALB' => 0x03,
  22. 'INTCONA' => 0x04, #If a bit is set, the corresponding I/O pin is compared against DEFVAL register. Otherwise against the previous value.
  23. 'INTCONB' => 0x04,
  24. 'IOCON' => 0x05,
  25. 'GPPUA' => 0x06, #100k pull up resistor for input
  26. 'GPPUB' => 0x06,
  27. 'INTFA' => 0x07, #shows which Pin caused the interrupt (ro)
  28. 'INTFB' => 0x07,
  29. 'INTCAPA' => 0x08, #status from all registers at the time the interrupt occured, remain unchanged until a read of INTCAP or GPIO. (ro)
  30. 'INTCAPB' => 0x08,
  31. 'GPIOA' => 0x09, #value on the ports (r/w)
  32. 'GPIOB' => 0x09,
  33. 'OLATA' => 0x0A,
  34. 'OLATB' => 0x0A,
  35. );
  36. my %setsP = (
  37. 'off' => 0,
  38. 'on' => 1,
  39. );
  40. my %intout = (
  41. 'separate_active-low' => 0x00,
  42. 'separate_active-high' => 0x02,
  43. 'separate_open-drain' => 0x04,
  44. );
  45. ###############################################################################
  46. sub I2C_MCP23008_Initialize($) {
  47. my ($hash) = @_;
  48. $hash->{DefFn} = "I2C_MCP23008_Define";
  49. $hash->{InitFn} = 'I2C_MCP23008_Init';
  50. $hash->{UndefFn} = "I2C_MCP23008_Undefine";
  51. $hash->{AttrFn} = "I2C_MCP23008_Attr";
  52. $hash->{StateFn} = "I2C_MCP23008_State";
  53. $hash->{SetFn} = "I2C_MCP23008_Set";
  54. $hash->{GetFn} = "I2C_MCP23008_Get";
  55. $hash->{I2CRecFn} = "I2C_MCP23008_I2CRec";
  56. $hash->{AttrList} = "IODev do_not_notify:1,0 ignore:1,0 showtime:1,0 ".
  57. "poll_interval OnStartup ".
  58. "OutputPorts:multiple-strict,A0,A1,A2,A3,A4,A5,A6,A7 ".
  59. "Pullup:multiple-strict,A0,A1,A2,A3,A4,A5,A6,A7 ".
  60. "invert_input:multiple-strict,A0,A1,A2,A3,A4,A5,A6,A7 ".
  61. "Interrupt:multiple-strict,A0,A1,A2,A3,A4,A5,A6,A7 ".
  62. "InterruptOut:separate_active-low,separate_active-high,separate_open-drain ".
  63. "$readingFnAttributes";
  64. }
  65. ###############################################################################
  66. sub I2C_MCP23008_Define($$) {
  67. my ($hash, $def) = @_;
  68. my @a = split("[ \t]+", $def);
  69. $hash->{STATE} = 'defined';
  70. if ($main::init_done) {
  71. eval { I2C_MCP23008_Init( $hash, [ @a[ 2 .. scalar(@a) - 1 ] ] ); };
  72. return I2C_MCP23008_Catch($@) if $@;
  73. }
  74. return undef;
  75. }
  76. ###############################################################################
  77. sub I2C_MCP23008_Init($$) { #Geraet beim anlegen/booten/nach Neuverbindung (wieder) initialisieren
  78. my ( $hash, $args ) = @_;
  79. if (defined $args && int(@$args) != 1) {
  80. return "Define: Wrong syntax. Usage:\n" .
  81. "define <name> I2C_MCP23008 <i2caddress>";
  82. }
  83. if (defined (my $address = shift @$args)) {
  84. $hash->{I2C_Address} = $address =~ /^0.*$/ ? oct($address) : $address;
  85. } else {
  86. return "$hash->{NAME} I2C Address not valid";
  87. }
  88. AssignIoPort($hash);
  89. my $msg = '';
  90. #Output level wieder setzen
  91. my $sbyte = 0;
  92. foreach (reverse 0..7) {
  93. $sbyte += $setsP{ReadingsVal($hash->{NAME},"PortA".$_,"off")} << ($_); #Werte fuer PortA aus dem Reading holen
  94. #$sbyte += $setsP{ReadingsVal($hash->{NAME},"PortB".$_,"off")} << (8 + $_);
  95. }
  96. $msg = I2C_MCP23008_SetRegPair($hash, $sbyte, "GPIO") if $sbyte;
  97. #bei Init IC neu konfigurieren
  98. if ( defined ( my $val = AttrVal($hash->{NAME},"invert_input",undef)) ) {
  99. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, "invert_input", $val);
  100. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "IPOL") unless $msg;
  101. }
  102. if ( defined ( my $val = AttrVal($hash->{NAME},"OutputPorts",undef)) ) {
  103. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, "OutputPorts", $val);
  104. $msg = I2C_MCP23008_SetRegPair($hash, ~$regval, "IODIR") unless $msg;
  105. }
  106. if ( defined ( my $val = AttrVal($hash->{NAME},"Pullup",undef)) ) {
  107. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, "Pullup", $val);
  108. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "GPPU") unless $msg;
  109. }
  110. if ( defined ( my $val = AttrVal($hash->{NAME},"Interrupt",undef)) ) {
  111. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, "Interrupt", $val);
  112. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "GPINTEN") unless $msg;
  113. }
  114. if ( defined ( my $val = AttrVal($hash->{NAME},"InterruptOut",undef)) ) {
  115. my $regval = 0;
  116. $regval = $intout{$val} if defined $val;
  117. if (defined (my $iodev = $hash->{IODev})) {
  118. CallFn($iodev->{NAME}, "I2CWrtFn", $iodev, {
  119. direction => "i2cwrite",
  120. i2caddress => $hash->{I2C_Address},
  121. reg => $Registers{IOCON},
  122. data => $regval,
  123. }) if (defined $hash->{I2C_Address});
  124. } else {
  125. return "no IODev assigned to '$hash->{NAME}'";
  126. }
  127. }
  128. #Output level wieder setzen die zweite
  129. #$sbyte = 0;
  130. #foreach (reverse 0..7) {
  131. # $sbyte += $setsP{ReadingsVal($hash->{NAME},"PortA".$_,"off")} << ($_); #Werte fuer PortA aus dem Reading holen
  132. # $sbyte += $setsP{ReadingsVal($hash->{NAME},"PortB".$_,"off")} << (8 + $_);
  133. #}
  134. #$msg = I2C_MCP23008_SetRegPair($hash, $sbyte, "GPIO") if $sbyte;
  135. I2C_MCP23008_Get($hash, $hash->{NAME});
  136. $hash->{STATE} = 'Initialized';
  137. return ($msg) ? $msg : undef;
  138. }
  139. ###############################################################################
  140. sub I2C_MCP23008_Catch($) { #Fehlermeldung von eval formattieren
  141. my $exception = shift;
  142. if ($exception) {
  143. $exception =~ /^(.*)( at.*FHEM.*)$/;
  144. return $1;
  145. }
  146. return undef;
  147. }
  148. ###############################################################################
  149. sub I2C_MCP23008_Undefine($$) {
  150. my ($hash, $arg) = @_;
  151. if ( defined (AttrVal($hash->{NAME}, "poll_interval", undef)) ) {
  152. RemoveInternalTimer($hash);
  153. }
  154. }
  155. ###############################################################################
  156. sub I2C_MCP23008_Attr(@) {
  157. my ($command, $name, $attr, $val) = @_;
  158. my $hash = $defs{$name};
  159. my $msg = '';
  160. if ($command && $command eq "set" && $attr && $attr eq "IODev") {
  161. if ($main::init_done and (!defined ($hash->{IODev}) or $hash->{IODev}->{NAME} ne $val)) {
  162. main::AssignIoPort($hash,$val);
  163. my @def = split (' ',$hash->{DEF});
  164. I2C_MCP23008_Init($hash,\@def) if (defined ($hash->{IODev}));
  165. }
  166. }
  167. if ($attr && $attr eq 'poll_interval') {
  168. #my $pollInterval = (defined($val) && looks_like_number($val) && $val > 0) ? $val : 0;
  169. if (!defined($val) ) {
  170. RemoveInternalTimer($hash);
  171. } elsif ($val > 0) {
  172. RemoveInternalTimer($hash);
  173. InternalTimer(1, 'I2C_MCP23008_Poll', $hash, 0);
  174. } else {
  175. $msg = 'Wrong poll intervall defined. poll_interval must be a number > 0';
  176. }
  177. } elsif ($attr && $attr eq "OutputPorts") {
  178. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, $attr, $val);
  179. $msg = I2C_MCP23008_SetRegPair($hash, ~$regval, "IODIR") unless $msg;
  180. } elsif ($attr && $attr eq "Pullup") {
  181. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, $attr, $val);
  182. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "GPPU") unless $msg;
  183. } elsif ($attr && $attr eq "invert_input") {
  184. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, $attr, $val);
  185. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "IPOL") unless $msg;
  186. } elsif ($attr && $attr eq "Interrupt") {
  187. ($msg, my $regval) = I2C_MCP23008_CheckAttr($hash, $attr, $val);
  188. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "GPINTEN") unless $msg;
  189. } elsif ($attr && $attr eq "OnStartup") {
  190. if (defined $val) {
  191. foreach (split (/,/,$val)) {
  192. my @pair = split (/=/,$_);
  193. $msg = "wrong value: $_ for \"attr $hash->{NAME} $attr\" use comma separated <port>=on|off|last where <port> = A0 - A7"
  194. unless ( scalar(@pair) == 2 &&
  195. $pair[0] =~ m/^(A)(0|)[0-7]$/i &&
  196. $pair[1] =~ m/^(on|off|last)$/i);
  197. }
  198. }
  199. } elsif ($attr && $attr eq "InterruptOut") {
  200. my $regval = 0;
  201. if (defined $val) {
  202. return "wrong value: $_ for \"attr $hash->{NAME} $attr\" use one of: " .
  203. join(',', (sort { $intout{ $a } <=> $intout{ $b } } keys %setsP) )
  204. unless(exists($intout{$val}));
  205. $regval = $intout{$val};
  206. }
  207. if (defined (my $iodev = $hash->{IODev})) {
  208. #Log3 $hash, 1, "schreibe raus: i2cwrite|$hash->{I2C_Address}|$Registers{$regtype . $reg}|$port{$reg}|";
  209. CallFn($iodev->{NAME}, "I2CWrtFn", $iodev, {
  210. direction => "i2cwrite",
  211. i2caddress => $hash->{I2C_Address},
  212. reg => $Registers{IOCON},
  213. data => $regval,
  214. }) if (defined $hash->{I2C_Address});
  215. } else {
  216. return "no IODev assigned to '$hash->{NAME}'";
  217. }
  218. }
  219. return ($msg) ? $msg : undef;
  220. }
  221. ###############################################################################
  222. sub I2C_MCP23008_State($$$$) { #reload readings at FHEM start
  223. my ($hash, $tim, $sname, $sval) = @_;
  224. Log3 $hash, 4, "$hash->{NAME}: $sname kann auf $sval wiederhergestellt werden $tim";
  225. if ($sname =~ m/^Port(A)(0|)[0-7]$/i) {
  226. my $po = substr $sname, 4, 2; # Ax oder Bx
  227. Log3 $hash, 5, "$hash->{NAME}: Port = $po";
  228. if ( index( AttrVal($hash->{NAME}, "OutputPorts", ""), $po, 0) >= 0 ) {
  229. if ( ( my $pos = index(AttrVal($hash->{NAME},"OnStartup", ""), $po ,0) ) >=0 ) {
  230. my $val = substr AttrVal($hash->{NAME},"OnStartup",undef), $pos + 3, 2;
  231. if ( $val eq "on" ) {
  232. Log3 $hash, 5, "$hash->{NAME}: $sname soll auf on gesetzt werden";
  233. readingsSingleUpdate($hash,$sname, "on", 1);
  234. } elsif ( $val eq "of" ) {
  235. Log3 $hash, 5, "$hash->{NAME}: $sname soll auf off gesetzt werden";
  236. readingsSingleUpdate($hash,$sname, "off", 1);
  237. } else {
  238. Log3 $hash, 5, "$hash->{NAME}: $sname soll auf Altzustand: $sval gesetzt werden";
  239. $hash->{READINGS}{$sname}{VAL} = $sval;
  240. $hash->{READINGS}{$sname}{TIME} = $tim;
  241. }
  242. } else {
  243. Log3 $hash, 5, "$hash->{NAME}: $sname wird auf Altzustand: $sval gesetzt (kein Eintrag in on Startup)";
  244. $hash->{READINGS}{$sname}{VAL} = $sval;
  245. $hash->{READINGS}{$sname}{TIME} = $tim;
  246. }
  247. } else {
  248. Log3 $hash, 5, "$hash->{NAME}: $sname ist Eingang";
  249. }
  250. }
  251. return undef;
  252. }
  253. ###############################################################################
  254. sub I2C_MCP23008_CheckAttr {
  255. my ($hash, $attr, $val) = @_;
  256. my $msg = undef;
  257. my ($regval) = 0;
  258. if (defined $val) {
  259. foreach (split (/,/,$val)) {
  260. $msg = "wrong value: $_ for \"attr $hash->{NAME} $attr\" use comma separated values from A0 - A7" unless ($_ =~ m/^(A)(0|)[0-7]$/i);
  261. #my $bank = ($_ =~ m/^A/) ? 0 : 8; # A oder B
  262. $_ =~ tr/[a-zA-Z]//d; #Nummer aus String extrahieren
  263. #$regval |= 1 << ($_ + $bank);
  264. $regval |= 1 << $_;
  265. }
  266. }
  267. return $msg, $regval;
  268. }
  269. ###############################################################################
  270. sub I2C_MCP23008_SetRegPair { #set register pair for PortA/B
  271. my ($hash, $regval, $regtype) = @_;
  272. my %port = ();
  273. $port{A} = $regval & 0xff;
  274. #$port{B} = ( $regval >> 8 ) & 0xff;
  275. if (defined (my $iodev = $hash->{IODev})) {
  276. foreach my $reg (keys %port) {
  277. #Log3 $hash, 1, "schreibe raus: i2cwrite|$hash->{I2C_Address}|$Registers{$regtype . $reg}|$port{$reg}|";
  278. CallFn($iodev->{NAME}, "I2CWrtFn", $iodev, {
  279. direction => "i2cwrite",
  280. i2caddress => $hash->{I2C_Address},
  281. reg => $Registers{$regtype . $reg},
  282. data => $port{$reg},
  283. }) if (defined $hash->{I2C_Address});
  284. }
  285. I2C_MCP23008_Get($hash,$hash->{NAME}) if ( ($iodev->{TYPE} ne "RPII2C") && ($regtype eq "GPIO") );
  286. } else {
  287. return "no IODev assigned to $hash->{NAME}";
  288. }
  289. }
  290. ###############################################################################
  291. sub I2C_MCP23008_Poll($) { #function for refresh intervall
  292. my ($hash) = @_;
  293. my $name = $hash->{NAME};
  294. # Read values
  295. I2C_MCP23008_Get($hash, $name);
  296. my $pollInterval = AttrVal($hash->{NAME}, 'poll_interval', 0);
  297. if ($pollInterval > 0) {
  298. InternalTimer(gettimeofday() + ($pollInterval * 60), 'I2C_MCP23008_Poll', $hash, 0);
  299. }
  300. }
  301. ###############################################################################
  302. sub I2C_MCP23008_Set($@) {
  303. my ($hash, @a) = @_;
  304. my $name =$a[0];
  305. my $cmd = $a[1];
  306. my $val = $a[2];
  307. #my @outports = sort(split(/,/,AttrVal($name, "OutputPorts", "")));
  308. unless (@a == 3) {
  309. }
  310. my $msg = undef;
  311. if ( $cmd && $cmd =~ m/^P(ort|)(A)((0|)[0-7])(,(P|)(ort|)(A|B)((0|)[0-7])){0,7}$/i) {
  312. return "wrong value: $val for \"set $name $cmd\" use one of: " .
  313. join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) )
  314. unless(exists($setsP{$val}));
  315. my @scmd = split(",", $cmd);
  316. foreach (@scmd) {
  317. $_ =~ tr/P(ort|)//d; #Nummer aus String extrahieren
  318. #$msg .= (defined $msg ? "," : "") . "Port" . $_ unless ( ($_) ~~ @outports ); #Pruefen ob entsprechender Port Input ist
  319. $msg .= (defined $msg ? "," : "") . "Port" . $_ unless ( AttrVal($name, "OutputPorts", "") =~ /$_/ ); #Pruefen ob entsprechender Port Input ist
  320. }
  321. return "$name error: $msg is defined as input" if $msg;
  322. #Log3 $hash, 1, "$name: multitest gereinigt: @scmd";
  323. my $regval = 0;
  324. foreach (reverse 0..7) {
  325. #foreach my $po ("A","B") {
  326. foreach my $po ("A") {
  327. my $bank = ($po eq "A") ? 0 : 8; # A oder B
  328. #if ( ($po.$_) ~~ @scmd ) { #->wenn aktueller Port in Liste dann neuer Wert
  329. if ( $cmd =~ /$po$_/ ) { #->wenn aktueller Port in Liste dann neuer Wert
  330. $regval += $setsP{$val} << ($bank + $_);
  331. } else { #->sonst aus dem Reading holen
  332. $regval += $setsP{ReadingsVal($name,"Port".$po.$_,"off")} << ($bank + $_);
  333. }
  334. }
  335. }
  336. #Log3 $hash, 1, "$name: endwert: $regval";
  337. $msg = I2C_MCP23008_SetRegPair($hash, $regval, "GPIO") unless $msg;
  338. } else {
  339. my $list = "";
  340. foreach (0..7) {
  341. #next unless ( ("A" . $_) ~~ @outports ); #Inputs ueberspringen
  342. next unless ( AttrVal($name, "OutputPorts", "") =~ /A$_/ ); #Inputs ueberspringen
  343. $list .= "PortA" . $_ . ":" . join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) ) . " ";
  344. }
  345. #foreach (0..7) {
  346. # next unless ( ("B" . $_) ~~ @outports ); #Inputs ueberspringen
  347. # $list .= "PortB" . $_ . ":" . join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) ) . " ";
  348. #}
  349. $msg = "Unknown argument $a[1], choose one of " . $list;
  350. }
  351. return ($msg) ? $msg : undef;
  352. ###########################################################################################################
  353. #alte einzelportversion
  354. # my %sendpackage = ( i2caddress => $hash->{I2C_Address}, direction => "i2cwrite" );
  355. # if ( $cmd && $cmd =~ m/^Port(A|B)(0|)[0-7]$/i) {
  356. # return "wrong value: $val for \"set $name $cmd\" use one of: " .
  357. # join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) )
  358. # unless(exists($setsP{$val}));
  359. # my $po = substr $cmd, 4, 1; # A oder B
  360. # my $regaddr = $po eq "A" ? $Registers{GPIOA} : $Registers{GPIOB}; #Adresse fuer GPIO Register
  361. # substr($cmd,0,5,"");
  362. # return "$name error: Port$po$cmd is defined as input" unless ( ($po . $cmd) ~~ @outports ); #Pruefen ob entsprechender Port Input ist
  363. #
  364. # my $sbyte = 0;
  365. # foreach (reverse 0..7) {
  366. # if ( $_ == $cmd ) { #->wenn aktueller Port dann neuer Wert
  367. # $sbyte += $setsP{$val} << ($_);
  368. # next;
  369. # }
  370. # $sbyte += $setsP{ReadingsVal($name,"Port".$po.$_,"off")} << ($_); #->sonst aus dem Reading holen
  371. # }
  372. #
  373. # $sendpackage{data} = $sbyte;
  374. # $sendpackage{reg} = $regaddr;
  375. # Log3 $hash, 5, "$name set regaddr: " . sprintf("%.2X",$sendpackage{reg}) . " inhalt: " . sprintf("%.2X",$sendpackage{data});
  376. # } else {
  377. # my $list = "";
  378. # foreach (0..7) {
  379. # next unless ( ("A" . $_) ~~ @outports ); #Inputs ueberspringen
  380. # $list .= "PortA" . $_ . ":" . join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) ) . " ";
  381. # }
  382. # foreach (0..7) {
  383. # next unless ( ("B" . $_) ~~ @outports ); #Inputs ueberspringen
  384. # $list .= "PortB" . $_ . ":" . join(',', (sort { $setsP{ $a } <=> $setsP{ $b } } keys %setsP) ) . " ";
  385. # }
  386. # return "Unknown argument $a[1], choose one of " . $list;
  387. # }
  388. # return "$name: no IO device defined" unless ($hash->{IODev});
  389. # my $phash = $hash->{IODev};
  390. # my $pname = $phash->{NAME};
  391. # CallFn($pname, "I2CWrtFn", $phash, \%sendpackage);
  392. }
  393. ###############################################################################
  394. sub I2C_MCP23008_Get($@) {
  395. my ($hash, @a) = @_;
  396. my $name =$a[0];
  397. my %sendpackage = ( i2caddress => $hash->{I2C_Address}, direction => "i2cread" );
  398. $sendpackage{reg} = $Registers{GPIOA}; #startadresse zum lesen
  399. $sendpackage{nbyte} = 1;
  400. return "$name: no IO device defined" unless ($hash->{IODev});
  401. my $phash = $hash->{IODev};
  402. my $pname = $phash->{NAME};
  403. CallFn($pname, "I2CWrtFn", $phash, \%sendpackage);
  404. }
  405. ###############################################################################
  406. sub I2C_MCP23008_I2CRec($@) { #ueber CallFn vom physical aufgerufen
  407. my ($hash, $clientmsg) = @_;
  408. my $name = $hash->{NAME};
  409. my $phash = $hash->{IODev};
  410. my $pname = $phash->{NAME};
  411. while ( my ( $k, $v ) = each %$clientmsg ) { #erzeugen von Internals fuer alle Keys in $clientmsg die mit dem physical Namen beginnen
  412. $hash->{$k} = $v if $k =~ /^$pname/ ;
  413. }
  414. #hier noch ueberpruefen, ob Register und Daten ok
  415. if ($clientmsg->{direction} && defined $clientmsg->{reg} && $clientmsg->{$pname . "_SENDSTAT"} && $clientmsg->{$pname . "_SENDSTAT"} eq "Ok" ) {
  416. if ($clientmsg->{direction} eq "i2cread" && defined $clientmsg->{received}) { # =~ m/^[a-f0-9]{2}$/i) {
  417. #my @rec = @{$clientmsg->{received}}; #bei uebergabe im hash als array
  418. my @rec = split(" ",$clientmsg->{received}); #bei uebergabe im als skalar
  419. Log3 $hash, 3, "$name: wrong amount of registers transmitted from $pname" unless (@rec == $clientmsg->{nbyte});
  420. foreach (reverse 0..$#rec) { #reverse, damit Inputs (Register 0 und 1 als letztes geschrieben werden)
  421. I2C_MCP23008_UpdReadings($hash, $_ + $clientmsg->{reg} , $rec[$_]);
  422. }
  423. readingsSingleUpdate($hash,"state", "Ok", 1);
  424. } elsif ($clientmsg->{direction} eq "i2cwrite" && defined $clientmsg->{data}) { # =~ m/^[a-f0-9]{2}$/i) {#readings aktualisieren wenn uebertragung ok
  425. I2C_MCP23008_UpdReadings($hash, $clientmsg->{reg} , $clientmsg->{data}) if ( ($clientmsg->{reg} == $Registers{GPIOA}) || ($clientmsg->{reg} == $Registers{GPIOB}) );
  426. readingsSingleUpdate($hash,"state", "Ok", 1);
  427. } else {
  428. readingsSingleUpdate($hash,"state", "transmission error", 1);
  429. Log3 $hash, 3, "$name: failurei in message from $pname";
  430. Log3 $hash, 3, (defined($clientmsg->{direction}) ? "Direction: " . $clientmsg->{direction} : "Direction: undef").
  431. (defined($clientmsg->{i2caddress}) ? " I2Caddress: " . sprintf("0x%.2X", $clientmsg->{i2caddress}) : " I2Caddress: undef").
  432. (defined($clientmsg->{reg}) ? " Register: " . sprintf("0x%.2X", $clientmsg->{reg}) : " Register: undef").
  433. (defined($clientmsg->{data}) ? " Data: " . sprintf("0x%.2X", $clientmsg->{data}) : " Data: undef").
  434. (defined($clientmsg->{received}) ? " received: " . sprintf("0x%.2X", $clientmsg->{received}) : " received: undef");
  435. }
  436. } else {
  437. readingsSingleUpdate($hash,"state", "transmission error", 1);
  438. Log3 $hash, 3, "$name: failure in message from $pname";
  439. Log3 $hash, 3,(defined($clientmsg->{direction}) ? "Direction: " . $clientmsg->{direction} : "Direction: undef").
  440. (defined($clientmsg->{i2caddress}) ? " I2Caddress: " . sprintf("0x%.2X", $clientmsg->{i2caddress}) : " I2Caddress: undef").
  441. (defined($clientmsg->{reg}) ? " Register: " . sprintf("0x%.2X", $clientmsg->{reg}) : " Register: undef").
  442. (defined($clientmsg->{data}) ? " Data: " . sprintf("0x%.2X", $clientmsg->{data}) : " Data: undef").
  443. (defined($clientmsg->{received}) ? " received: " . sprintf("0x%.2X", $clientmsg->{received}) : " received: undef");
  444. #my $cmsg = undef;
  445. #foreach my $av (keys %{$clientmsg}) { $cmsg .= "|" . $av . ": " . $clientmsg->{$av}; }
  446. #Log3 $hash, 3, $cmsg;
  447. }
  448. }
  449. ###############################################################################
  450. sub I2C_MCP23008_UpdReadings($$$) { #nach Rueckmeldung readings updaten (ueber I2CRec aufgerufen)
  451. my ($hash, $reg, $inh) = @_;
  452. my $name = $hash->{NAME};
  453. #$inh = hex($inh);
  454. #$reg = hex($reg);
  455. Log3 $hash, 5, "$name UpdReadings Register: $reg, Inhalt: $inh";
  456. readingsBeginUpdate($hash);
  457. if ($reg == $Registers{GPIOA}) {
  458. my %rsetsP = reverse %setsP;
  459. foreach (0..7) {
  460. my $pval = 1 & ( $inh >> $_ );
  461. readingsBulkUpdate($hash, 'PortA'.$_ , $rsetsP{$pval})
  462. if (ReadingsVal($name, 'PortA'.$_,"nix") ne $rsetsP{$pval}); #nur wenn Wert geaendert
  463. }
  464. } #elsif ($reg == $Registers{GPIOB}) {
  465. #my %rsetsP = reverse %setsP;
  466. #foreach (0..7) {
  467. # my $pval = 1 & ( $inh >> $_ );
  468. # readingsBulkUpdate($hash, 'PortB'.$_ , $rsetsP{$pval})
  469. # if (ReadingsVal($name, 'PortB'.$_,"nix") ne $rsetsP{$pval}); #nur wenn Wert geaendert
  470. #}
  471. #}
  472. readingsEndUpdate($hash, 1);
  473. return;
  474. }
  475. 1;
  476. =pod
  477. =item device
  478. =item summary controls/reads GPIOs from an via I2C connected MCP23008 port extender
  479. =item summary_DE steuern/lesen der GPIOs eines &uuml;ber I2C angeschlossenen MCP23008
  480. =begin html
  481. <a name="I2C_MCP23008"></a>
  482. <h3>I2C_MCP23008</h3>
  483. (en | <a href="commandref_DE.html#I2C_MCP23008">de</a>)
  484. <ul>
  485. <a name="I2C_MCP23008"></a>
  486. Provides an interface to the MCP23008 16 channel port extender IC. On Raspberry Pi the Interrupt Pin's can be connected to an GPIO and <a href="#RPI_GPIO">RPI_GPIO</a> can be used to get the port values if an interrupt occurs.<br>
  487. The I2C messages are send through an I2C interface module like <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
  488. or <a href="#NetzerI2C">NetzerI2C</a> so this device must be defined first.<br>
  489. <b>attribute IODev must be set</b><br>
  490. <a name="I2C_MCP23008Define"></a><br>
  491. <b>Define</b>
  492. <ul>
  493. <code>define &lt;name&gt; I2C_MCP23008 &lt;I2C Address&gt;</code><br>
  494. where <code>&lt;I2C Address&gt;</code> is without direction bit<br>
  495. </ul>
  496. <a name="I2C_MCP23008Set"></a>
  497. <b>Set</b>
  498. <ul>
  499. <code>set &lt;name&gt; &lt;port[,port[...]]&gt; &lt;value&gt;</code><br><br>
  500. where <code>&lt;port&gt;</code> is one of PortA0 to PortA7 and <code>&lt;value&gt;</code> is one of:<br>
  501. <ul>
  502. <code>
  503. off<br>
  504. on<br>
  505. </code>
  506. </ul>
  507. <br>
  508. Example:
  509. <ul>
  510. <code>set mod1 PortA4 on</code><br>
  511. <code>set mod1 PortA4,PortA6 off</code><br>
  512. <code>set mod1 PortA4,A6 on</code><br>
  513. </ul><br>
  514. </ul>
  515. <a name="I2C_MCP23008Get"></a>
  516. <b>Get</b>
  517. <ul>
  518. <code>get &lt;name&gt;</code>
  519. <br><br>
  520. refreshes all readings
  521. </ul><br>
  522. <a name="I2C_MCP23008Attr"></a>
  523. <b>Attributes</b>
  524. <ul>
  525. <li>poll_interval<br>
  526. Set the polling interval in minutes to query the GPIO's level<br>
  527. Default: -, valid values: decimal number<br><br>
  528. </li>
  529. <li>OutputPorts<br>
  530. Comma separated list of ports that are used as Output<br>
  531. Ports not in this list can't be written<br>
  532. Default: no, valid values: A0-A7<br><br>
  533. </li>
  534. <li>OnStartup<br>
  535. Comma separated list of output ports and their desired state after start<br>
  536. Without this atribut all output ports will set to last state<br>
  537. Default: -, valid values: &lt;port&gt;=on|off|last where &lt;port&gt; = A0-A7<br><br>
  538. </li>
  539. <li>Pullup<br>
  540. Comma separated list of input ports which switch on their internal 100k pullup<br>
  541. Default: -, valid values: A0-A7<br><br>
  542. </li>
  543. <li>Interrupt<br>
  544. Comma separated list of input ports which will trigger the IntA/B pin<br>
  545. Default: -, valid values: A0-A7<br><br>
  546. </li>
  547. <li>invert_input<br>
  548. Comma separated list of input ports which use inverted logic<br>
  549. Default: -, valid values: A0-A7<br><br>
  550. </li>
  551. <li>InterruptOut<br>
  552. Configuration options for INT output pin<br>
  553. Values:<br>
  554. <ul>
  555. <li>
  556. active-low (INT output is active low)
  557. </li>
  558. <li>
  559. active-high (INT output is active high)
  560. </li>
  561. <li>
  562. open-drain (INTA output is open drain)
  563. </li><br>
  564. </ul>
  565. </li>
  566. <li><a href="#IODev">IODev</a></li>
  567. <li><a href="#ignore">ignore</a></li>
  568. <li><a href="#do_not_notify">do_not_notify</a></li>
  569. <li><a href="#showtime">showtime</a></li>
  570. </ul>
  571. <br>
  572. </ul>
  573. =end html
  574. =begin html_DE
  575. <a name="I2C_MCP23008"></a>
  576. <h3>I2C_MCP23008</h3>
  577. (<a href="commandref.html#I2C_MCP23008">en</a> | de)
  578. <ul>
  579. <a name="I2C_MCP23008"></a>
  580. Erm&ouml;glicht die Verwendung eines MCP23008 I2C 8 Bit Portexenders.
  581. Auf einem Raspberry Pi kann der Interrupt Pin des MCP23008 mit einem GPIO verbunden werden und &uuml;ber die Interrupt Funktionen von <a href="#RPI_GPIO">RPI_GPIO</a> l&auml;sst sich dann ein get f&uuml;r den MCP23008 bei Pegel&auml;nderung ausl&ouml;sen.<br>
  582. I2C-Botschaften werden &uuml;ber ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
  583. oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
  584. <b>Das Attribut IODev muss definiert sein.</b><br>
  585. <a name="I2C_MCP23008Define"></a><br>
  586. <b>Define</b>
  587. <ul>
  588. <code>define &lt;name&gt; I2C_MCP23008 &lt;I2C Address&gt;</code><br>
  589. Der Wert <code>&lt;I2C Address&gt;</code> ist ohne das Richtungsbit<br>
  590. </ul>
  591. <a name="I2C_MCP23008Set"></a>
  592. <b>Set</b>
  593. <ul>
  594. <code>set &lt;name&gt; &lt;port[,port[...]]&gt; &lt;value&gt;</code><br><br>
  595. <code>&lt;port&gt;</code> kann PortA0 bis PortA7 annehmen und <code>&lt;value&gt;</code> folgende Werte:<br>
  596. <ul>
  597. <code>
  598. off<br>
  599. on<br>
  600. </code>
  601. </ul>
  602. <br>
  603. Beispiel:
  604. <ul>
  605. <code>set mod1 PortA4 on</code><br>
  606. <code>set mod1 PortA4,PortA6 off</code><br>
  607. <code>set mod1 PortA4,A6 on</code><br>
  608. </ul><br>
  609. </ul>
  610. <a name="I2C_MCP23008Get"></a>
  611. <b>Get</b>
  612. <ul>
  613. <code>get &lt;name&gt;</code>
  614. <br><br>
  615. Aktualisierung aller Werte
  616. </ul><br>
  617. <a name="I2C_MCP23008Attr"></a>
  618. <b>Attribute</b>
  619. <ul>
  620. <li>poll_interval<br>
  621. Aktualisierungsintervall aller Werte in Minuten.<br>
  622. Standard: -, g&uuml;ltige Werte: Dezimalzahl<br><br>
  623. </li>
  624. <li>OutputPorts<br>
  625. Durch Komma getrennte Ports die als Ausg&auml;nge genutzt werden sollen.<br>
  626. Nur Ports in dieser Liste k&ouml;nnen gesetzt werden.<br>
  627. Standard: -, g&uuml;ltige Werte: A0-A7<br><br>
  628. </li>
  629. <li>OnStartup<br>
  630. Durch Komma getrennte Output Ports und ihr gew&uuml;nschter Status nach dem Start.<br>
  631. Ohne dieses Attribut werden alle Ausg&auml;nge nach dem Start auf den letzten Status gesetzt.<br>
  632. Standard: -, g&uuml;ltige Werte: &lt;port&gt;=on|off|last wobei &lt;port&gt; = A0-A7<br><br>
  633. </li>
  634. <li>Pullup<br>
  635. Durch Komma getrennte Input Ports, bei denen der interne 100k pullup aktiviert werden soll.<br>
  636. Standard: -, g&uuml;ltige Werte: A0-A7<br><br>
  637. </li>
  638. <li>Interrupt<br>
  639. Durch Komma getrennte Input Ports, die einen Interrupt auf IntA/B ausl&ouml;sen.<br>
  640. Standard: -, g&uuml;ltige Werte: A0-A7<br><br>
  641. </li>
  642. <li>invert_input<br>
  643. Durch Komma getrennte Input Ports, die reverse Logik nutzen.<br>
  644. Standard: -, g&uuml;ltige Werte: A0-A7<br><br>
  645. </li>
  646. <li>InterruptOut<br>
  647. Einstellungen f&uuml;r den INT Pin<br>
  648. g&uuml;ltige Werte:<br>
  649. <ul>
  650. <li>
  651. active-low (INT ist active low)
  652. </li>
  653. <li>
  654. active-high (INT ist active high)
  655. </li>
  656. <li>
  657. open-drain (INT ist open drain)
  658. </li><br>
  659. </ul>
  660. </li>
  661. <li><a href="#IODev">IODev</a></li>
  662. <li><a href="#ignore">ignore</a></li>
  663. <li><a href="#do_not_notify">do_not_notify</a></li>
  664. <li><a href="#showtime">showtime</a></li>
  665. </ul>
  666. <br>
  667. </ul>
  668. =end html_DE
  669. =cut