php-linux-gpio/lib/GpioPin.php

259 lines
6.6 KiB
PHP
Raw Permalink Normal View History

<?php
/*
* Copyright (C) 2014, NoccyLabs
*
* This program 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 3 of the License, or
* (at your option) any later version.
*
* This program 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.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
namespace NoccyLabs\Gpio;
2014-06-12 00:35:19 +00:00
use NoccyLabs\Gpio\Exception\HardwareException;
use NoccyLabs\Sansi\Charset as CS;
/**
* GPIO pin implementation. This class wraps all interaction with a GPIO pin,
* thus decoupling it from the main Gpio class.
*
*/
class GpioPin
{
protected $fd;
protected $pin;
protected $value = 0;
protected $direction;
protected $edge;
protected $handler;
2014-06-12 00:54:55 +00:00
protected $hardware;
protected $label;
2014-06-12 00:35:19 +00:00
protected $gpio;
2014-06-12 00:35:19 +00:00
public function __construct($pin, Gpio $gpio)
{
$this->pin = (int)$pin;
2014-06-12 00:35:19 +00:00
$this->gpio = $gpio;
2014-06-12 00:54:55 +00:00
}
2014-06-14 22:34:33 +00:00
public function getPin()
{
return $this->pin;
}
2014-06-12 00:54:55 +00:00
private function findHardware()
{
$chips = glob("/sys/class/gpio/gpiochip*");
$pinchip = null;
foreach($chips as $chip) {
$r = null;
if (preg_match("/([0-9]+?)/", $chip, $r)) {
$base = (int)$r[1];
if ($base < $this->pin) { $pinchip = $chip; }
}
}
if ($pinchip) {
$hw = trim(file_get_contents($pinchip."/label"));
return $hw;
}
return "unknown";
}
public function __destruct()
{
if ($this->fd) {
fclose($this->fd);
}
}
public function setDirection($direction)
{
2014-06-12 00:54:55 +00:00
if (!in_array($direction, array("in", "out"))) {
throw new \Exception;
}
$this->direction = $direction;
2014-06-12 00:54:55 +00:00
$this->sysfsWrite($this->pin, "direction", $direction);
return $this;
}
public function getDirection()
{
2014-06-12 00:54:55 +00:00
return $this->sysfsRead($this->pin, "direction");
}
public function setValue($value)
{
$this->value = (bool)$value;
2014-06-11 23:59:17 +00:00
@file_put_contents("/sys/class/gpio/gpio{$this->pin}/value", (int)$this->value);
return $this;
}
public function getValue()
{
2014-06-12 00:54:55 +00:00
return $this->sysfsRead($this->pin, "value");
}
2014-06-12 00:35:19 +00:00
/**
* Set a descriptive label for the pin, used for debugging and troubleshooting.
*
* @param string $label
* @return NoccyLabs\Gpio\GpioPin
*/
public function setLabel($label)
{
$this->label = (string)$label;
return $this;
}
2014-06-12 00:35:19 +00:00
/**
* Get the assigned label for this pin.
*
* @return string The label
*/
public function getLabel()
{
return $this->label;
}
public function export()
{
2014-06-12 00:54:55 +00:00
if (file_exists("/sys/class/gpio/gpio{$this->pin}")) {
return $this;
}
2014-06-12 00:35:19 +00:00
$this->sysfsWrite(null, "export", $this->pin);
if (!file_exists("/sys/class/gpio/gpio{$this->pin}")) {
2014-06-12 00:35:19 +00:00
throw new HardwareException("Unable to export pin {$this->pin}");
}
2014-06-14 01:10:07 +00:00
$this->hardware = $this->findHardware();
return $this;
}
public function unexport()
{
2014-06-12 00:54:55 +00:00
$this->sysfsWrite(null, "unexport", $this->pin);
return $this;
}
2014-06-12 00:35:19 +00:00
public function sysfsWrite($pin, $file, $value)
{
if ($pin!==null) {
2014-06-12 00:35:19 +00:00
$path = "/sys/class/gpio/gpio{$pin}/{$file}";
} else {
$path = "/sys/class/gpio/{$file}";
}
if (!file_exists($path)) {
throw new HardwareException("Sysfs file {$path} does not exist");
2014-06-12 00:35:19 +00:00
}
$ts = microtime(true);
while ((!is_writable($path)) && (microtime(true) < $ts+1)) {
usleep(10000);
}
$f = @fopen($path,"c");
2014-06-12 00:35:19 +00:00
if (!is_resource($f)) {
$err = error_get_last();
throw new HardwareException("Unable to write to sysfs file {$path}: ".$err['message']);
2014-06-12 00:35:19 +00:00
}
fwrite($f,$value);
fclose($f);
}
public function sysfsRead($pin, $file)
{
$path = "/sys/class/gpio/gpio{$pin}/{$file}";
$f = fopen($path,"r");
if (!is_resource($f)) {
throw new HardwareException("Unable to read from sysfs file {$path}");
}
$ret = fgets($f);
fclose($f);
2014-06-12 00:54:55 +00:00
return trim($ret);
2014-06-12 00:35:19 +00:00
}
public function setEdge($edge)
{
if (!in_array($edge, array("rising", "falling", "both", "none"))) {
throw new \Exception;
}
$this->edge = $edge;
2014-06-12 00:35:19 +00:00
$this->sysfsWrite($this->pin, "edge", $edge);
return $this;
}
public function getEdge()
{
2014-06-12 00:35:19 +00:00
return $this->sysfsRead($this->pin, "edge");
}
public function setHandler(callable $handler=null)
{
2014-06-12 00:35:19 +00:00
$this->gpio->setInterruptHandler($this->pin, $this->fd);
return $this;
}
public function doInterrupt()
{
fseek($this->fd,0,SEEK_SET);
$val = fgets($this->fd);
}
public function dumpStatus($ansi=false)
{
if ($ansi) {
2014-06-11 23:21:08 +00:00
$status = "\e[44;37;1m GPIO{$this->pin} \e[0m\n";
2014-06-11 23:53:57 +00:00
$direction =
($this->direction=="input"?(CS::chr(0x2190)):(CS::chr(0x2192))).
2014-06-11 23:53:57 +00:00
" ".$this->direction;
$edge = $this->edge; //"";
/*if ($this->edge == "rising") {
$edge.= CS::chr(0x21A5)." rising";
} elseif ($this->edge == "falling") {
2014-06-11 23:53:57 +00:00
$edge.= CS::chr(0x21A7)." falling";
} else {
$edge.= "\e[0m".$this->edge;
2014-06-11 23:53:57 +00:00
}*/
} else {
$status = "********** GPIO{$this->pin} **********\n";
$direction = $this->direction;
}
foreach(array(
2014-06-12 00:54:55 +00:00
"Direction" => $this->getDirection(),
"Value" => ($this->getValue()?1:0),
"Edge" => $this->getEdge(),
"Label" => $this->label,
2014-06-12 00:54:55 +00:00
"Hardware" => $this->hardware,
"Int count" => 0
) as $k=>$v) {
if ($ansi) {
$status.= sprintf(" \e[32;1m%10s\e[0m: \e[0m%s\e[0m\n", $k, $v);
} else {
$status.= sprintf(" %-10s: %s\n", $k, $v);
}
}
error_log($status);
return $this;
}
}