The requested page could not be found.
+You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.
+To continue please try to find requested page in the menu, or use search field on the top.
+Gpio interface
+
+ public
+
+
+
+
+ |
+
+ + |
+ public
+
+ integer[]
+
+
+ |
+
+ + |
+ public
+
+ mixed
+
+
+ |
+
+ + |
+ public
+
+ false|string
+
+
+ |
+
+ + |
+ public
+
+ mixed
+
+
+ |
+
+ + |
+ public
+
+ mixed
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ false|string
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ DIRECTION_IN,
+ DIRECTION_OUT,
+ IO_VALUE_OFF,
+ IO_VALUE_ON,
+ PATH_EXPORT,
+ PATH_GPIO,
+ PATH_UNEXPORT
+ |
+
This Gpio class is for developing not in raspberry environment +There is no need for root user and special file structure.
+
+ public
+
+ array
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+ integer
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ string
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ DIRECTION_IN,
+ DIRECTION_OUT,
+ IO_VALUE_OFF,
+ IO_VALUE_ON,
+ PATH_EXPORT,
+ PATH_GPIO,
+ PATH_UNEXPORT
+ |
+
+ public
+ array
+ |
+
+
+ $pins
+
+
+
+
+
+
+ |
+
+
+ #
+
+ array(14, 15, 17, 18)
+ |
+
+ public
+ array
+ |
+
+
+ $hackablePins
+
+
+
+
+
+
+ |
+
+
+ #
+
+ array(17, 18)
+ |
+
+ public
+ integer
+ |
+
+
+ $inputValue
+
+
+
+
+
+
+ |
+ + + | +
+ public
+ string
+ |
+
+
+ $direction
+
+
+
+
+
+
+ |
+ + + | +
Gpio interface
+
+ public
+
+ array
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+ integer
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ string
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
string |
+
+
+ DIRECTION_IN
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ 'in'
+ |
+
string |
+
+
+ DIRECTION_OUT
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ 'out'
+ |
+
integer |
+
+
+ IO_VALUE_ON
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ 1
+ |
+
integer |
+
+
+ IO_VALUE_OFF
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ 0
+ |
+
string |
+
+
+ PATH_GPIO
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ '/sys/class/gpio/gpio'
+ |
+
string |
+
+
+ PATH_EXPORT
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ '/sys/class/gpio/export'
+ |
+
string |
+
+
+ PATH_UNEXPORT
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ '/sys/class/gpio/unexport'
+ |
+
+ public
+
+ decimal
+
+
+ |
+
+ + |
+ public
+
+ string.
+
+
+ |
+
+ + |
+ public
+
+ integer.
+
+
+ |
+
+ + |
+ public
+
+ integer.
+
+
+ |
+
+
+ #
+ getGpuTemp( $fahrenheit = false )
+
+
+
+
+
+ Get the temperature of the Graphical Porcessing Unit. + |
+
+ public
+
+ integer
+
+
+ |
+
+ + |
Interface implemented by sensors classes.
+
+ public
+
+
+
+
+ |
+
+ + |
+ public
+
+
+
+
+ |
+
+ + |
+ public
+
+
+
+
+ |
+
+ + |
+ public
+
+ string
+
+
+ |
+
+ + |
+ public
+
+ float
+
+
+ |
+
+ + |
+ public
+
+ boolean
+
+
+ |
+
+ + |
string |
+
+
+ BASEPATH
+
+
+
+
+
+
+
+ |
+
+
+ #
+
+ '/sys/bus/w1/devices/28-'
+ |
+
The MCP3002 has a 10-bit analog to digital converter (ADC) with a simple to use SPI interface.
+
+ public
+
+
+
+
+ |
+
+
+ #
+ __construct( integer $clockpin, integer $mosipin, integer $misopin, integer $cspin )
+
+
+
+
+
+ Constructor with the sused GPIOs. + |
+
+ public
+
+ integer
+
+
+ |
+
+ + |
+ public
+
+
+
+
+ |
+
+ + |
Interface implemented by sensors classes.
+
+ public
+
+ float
+
+
+ |
+
+ + |
+ public
+
+
+
+
+ |
+
+ + |
| PhpGpio | +
| PhpGpio\Sensors | +
| DS18B20 | +Interface implemented by sensors classes. | +
| MCP3002 | +The MCP3002 has a 10-bit analog to digital converter (ADC) with a simple to use SPI interface. | +
| SensorInterface | +Interface implemented by sensors classes. | +
| PhpGpio\Sensors | +
| Gpio | +Gpio interface | +
| GpioDevelop | +This Gpio class is for developing not in raspberry environment +There is no need for root user and special file structure. |
+
| Pi | ++ |
| GpioInterface | +Gpio interface | +
| t |
| 's parent ( |
| itself.
+ */
+jQuery.fn.sortElements = (function(){
+
+ var sort = [].sort;
+
+ return function(comparator, getSortable) {
+
+ getSortable = getSortable || function(){return this;};
+
+ var placements = this.map(function(){
+
+ var sortElement = getSortable.call(this),
+ parentNode = sortElement.parentNode,
+
+ // Since the element itself will change position, we have
+ // to have some way of storing it's original position in
+ // the DOM. The easiest way is to have a 'flag' node:
+ nextSibling = parentNode.insertBefore(
+ document.createTextNode(''),
+ sortElement.nextSibling
+ );
+
+ return function() {
+
+ if (parentNode === this) {
+ throw new Error(
+ "You can't sort elements if any one is a descendant of another."
+ );
+ }
+
+ // Insert before flag:
+ parentNode.insertBefore(this, nextSibling);
+ // Remove flag:
+ parentNode.removeChild(nextSibling);
+
+ };
+
+ });
+
+ return sort.call(this, comparator).each(function(i){
+ placements[i].call(getSortable.call(this));
+ });
+
+ };
+
+})();
+ $(window).load(function() {
+ var $document = $(document);
+ var $left = $('#left');
+ var $right = $('#right');
+ var $rightInner = $('#rightInner');
+ var $splitter = $('#splitter');
+ var $groups = $('#groups');
+ var $content = $('#content');
+
+ // Menu
+
+ // Hide deep packages and namespaces
+ $('ul span', $groups).click(function(event) {
+ event.preventDefault();
+ event.stopPropagation();
+ $(this)
+ .toggleClass('collapsed')
+ .parent()
+ .next('ul')
+ .toggleClass('collapsed');
+ }).click();
+
+ $active = $('ul li.active', $groups);
+ if ($active.length > 0) {
+ // Open active
+ $('> a > span', $active).click();
+ } else {
+ $main = $('> ul > li.main', $groups);
+ if ($main.length > 0) {
+ // Open first level of the main project
+ $('> a > span', $main).click();
+ } else {
+ // Open first level of all
+ $('> ul > li > a > span', $groups).click();
+ }
+ }
+
+ // Content
+
+ // Search autocompletion
+ var autocompleteFound = false;
+ var autocompleteFiles = {'c': 'class', 'co': 'constant', 'f': 'function', 'm': 'class', 'mm': 'class', 'p': 'class', 'mp': 'class', 'cc': 'class'};
+ var $search = $('#search input[name=q]');
+ $search
+ .autocomplete(ApiGen.elements, {
+ matchContains: true,
+ scrollHeight: 200,
+ max: 20,
+ noRecord: '',
+ highlight: function(value, term) {
+ var term = term.toUpperCase().replace(/([\^\$\(\)\[\]\{\}\*\.\+\?\|\\])/gi, "\\$1").replace(/[A-Z0-9]/g, function(m, offset) {
+ return offset === 0 ? '(?:' + m + '|^' + m.toLowerCase() + ')' : '(?:(?:[^<>]|<[^<>]*>)*' + m + '|' + m.toLowerCase() + ')';
+ });
+ return value.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + term + ")(?![^<>]*>)(?![^&;]+;)"), "$1");
+ },
+ formatItem: function(data) {
+ return data.length > 1 ? data[1].replace(/^(.+\\)(.+)$/, '$1$2') : data[0];
+ },
+ formatMatch: function(data) {
+ return data[1];
+ },
+ formatResult: function(data) {
+ return data[1];
+ },
+ show: function($list) {
+ var $items = $('li span', $list);
+ var maxWidth = Math.max.apply(null, $items.map(function() {
+ return $(this).width();
+ }));
+ // 10px padding
+ $list
+ .width(Math.max(maxWidth + 10, $search.innerWidth()))
+ .css('left', $search.offset().left + $search.outerWidth() - $list.outerWidth());
+ }
+ }).result(function(event, data) {
+ autocompleteFound = true;
+ var location = window.location.href.split('/');
+ location.pop();
+ var parts = data[1].split(/::|$/);
+ var file = $.sprintf(ApiGen.config.templates[autocompleteFiles[data[0]]].filename, parts[0].replace(/\(\)/, '').replace(/[^\w]/g, '.'));
+ if (parts[1]) {
+ file += '#' + ('mm' === data[0] || 'mp' === data[0] ? 'm' : '') + parts[1].replace(/([\w]+)\(\)/, '_$1');
+ }
+ location.push(file);
+ window.location = location.join('/');
+
+ // Workaround for Opera bug
+ $(this).closest('form').attr('action', location.join('/'));
+ }).closest('form')
+ .submit(function() {
+ var query = $search.val();
+ if ('' === query) {
+ return false;
+ }
+ return !autocompleteFound && '' !== $('#search input[name=cx]').val();
+ });
+
+ // Save natural order
+ $('table.summary tr[data-order]', $content).each(function(index) {
+ do {
+ index = '0' + index;
+ } while (index.length < 3);
+ $(this).attr('data-order-natural', index);
+ });
+
+ // Switch between natural and alphabetical order
+ var $caption = $('table.summary', $content)
+ .filter(':has(tr[data-order])')
+ .find('caption');
+ $caption
+ .click(function() {
+ var $this = $(this);
+ var order = $this.data('order') || 'natural';
+ order = 'natural' === order ? 'alphabetical' : 'natural';
+ $this.data('order', order);
+ $.cookie('order', order, {expires: 365});
+ var attr = 'alphabetical' === order ? 'data-order' : 'data-order-natural';
+ $this
+ .closest('table')
+ .find('tr').sortElements(function(a, b) {
+ return $(a).attr(attr) > $(b).attr(attr) ? 1 : -1;
+ });
+ return false;
+ })
+ .addClass('switchable')
+ .attr('title', 'Switch between natural and alphabetical order');
+ if ((null === $.cookie('order') && 'alphabetical' === ApiGen.config.options.elementsOrder) || 'alphabetical' === $.cookie('order')) {
+ $caption.click();
+ }
+
+ // Open details
+ if (ApiGen.config.options.elementDetailsCollapsed) {
+ $('tr', $content).filter(':has(.detailed)')
+ .click(function() {
+ var $this = $(this);
+ $('.short', $this).hide();
+ $('.detailed', $this).show();
+ });
+ }
+
+ // Splitter
+ var splitterWidth = $splitter.width();
+ var splitterPosition = $.cookie('splitter') ? parseInt($.cookie('splitter')) : null;
+ var splitterPositionBackup = $.cookie('splitterBackup') ? parseInt($.cookie('splitterBackup')) : null;
+ function setSplitterPosition(position)
+ {
+ splitterPosition = position;
+
+ $left.width(position);
+ $right.css('margin-left', position + splitterWidth);
+ $splitter.css('left', position);
+ }
+ function setContentWidth()
+ {
+ var width = $rightInner.width();
+ $rightInner
+ .toggleClass('medium', width <= 960)
+ .toggleClass('small', width <= 650);
+ }
+ $splitter.mousedown(function() {
+ $splitter.addClass('active');
+
+ $document.mousemove(function(event) {
+ if (event.pageX >= 230 && $document.width() - event.pageX >= 600 + splitterWidth) {
+ setSplitterPosition(event.pageX);
+ setContentWidth();
+ }
+ });
+
+ $()
+ .add($splitter)
+ .add($document)
+ .mouseup(function() {
+ $splitter
+ .removeClass('active')
+ .unbind('mouseup');
+ $document
+ .unbind('mousemove')
+ .unbind('mouseup');
+
+ $.cookie('splitter', splitterPosition, {expires: 365});
+ });
+
+ return false;
+ });
+ $splitter.dblclick(function() {
+ if (splitterPosition) {
+ splitterPositionBackup = $left.width();
+ setSplitterPosition(0);
+ } else {
+ setSplitterPosition(splitterPositionBackup);
+ splitterPositionBackup = null;
+ }
+
+ setContentWidth();
+
+ $.cookie('splitter', splitterPosition, {expires: 365});
+ $.cookie('splitterBackup', splitterPositionBackup, {expires: 365});
+ });
+ if (null !== splitterPosition) {
+ setSplitterPosition(splitterPosition);
+ }
+ setContentWidth();
+ $(window).resize(setContentWidth);
+
+ // Select selected lines
+ var matches = window.location.hash.substr(1).match(/^\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*$/);
+ if (null !== matches) {
+ var lists = matches[0].split(',');
+ for (var i = 0; i < lists.length; i++) {
+ var lines = lists[i].split('-');
+ lines[0] = parseInt(lines[0]);
+ lines[1] = parseInt(lines[1] || lines[0]);
+ for (var j = lines[0]; j <= lines[1]; j++) {
+ $('#' + j).addClass('selected');
+ }
+ }
+
+ var $firstLine = $('#' + parseInt(matches[0]));
+ if ($firstLine.length > 0) {
+ $document.scrollTop($firstLine.offset().top);
+ }
+ }
+
+ // Save selected lines
+ var lastLine;
+ $('.l a').click(function(event) {
+ event.preventDefault();
+
+ var $selectedLine = $(this).parent();
+ var selectedLine = parseInt($selectedLine.attr('id'));
+
+ if (event.shiftKey) {
+ if (lastLine) {
+ for (var i = Math.min(selectedLine, lastLine); i <= Math.max(selectedLine, lastLine); i++) {
+ $('#' + i).addClass('selected');
+ }
+ } else {
+ $selectedLine.addClass('selected');
+ }
+ } else if (event.ctrlKey) {
+ $selectedLine.toggleClass('selected');
+ } else {
+ var $selected = $('.l.selected')
+ .not($selectedLine)
+ .removeClass('selected');
+ if ($selected.length > 0) {
+ $selectedLine.addClass('selected');
+ } else {
+ $selectedLine.toggleClass('selected');
+ }
+ }
+
+ lastLine = $selectedLine.hasClass('selected') ? selectedLine : null;
+
+ // Update hash
+ var lines = $('.l.selected')
+ .map(function() {
+ return parseInt($(this).attr('id'));
+ })
+ .get()
+ .sort(function(a, b) {
+ return a - b;
+ });
+
+ var hash = [];
+ var list = [];
+ for (var j = 0; j < lines.length; j++) {
+ if (0 === j && j + 1 === lines.length) {
+ hash.push(lines[j]);
+ } else if (0 === j) {
+ list[0] = lines[j];
+ } else if (lines[j - 1] + 1 !== lines[j] && j + 1 === lines.length) {
+ hash.push(list.join('-'));
+ hash.push(lines[j]);
+ } else if (lines[j - 1] + 1 !== lines[j]) {
+ hash.push(list.join('-'));
+ list = [lines[j]];
+ } else if (j + 1 === lines.length) {
+ list[1] = lines[j];
+ hash.push(list.join('-'));
+ } else {
+ list[1] = lines[j];
+ }
+ }
+
+ hash = hash.join(',');
+ $backup = $('#' + hash).removeAttr('id');
+ window.location.hash = hash;
+ $backup.attr('id', hash);
+ });
+});
+
diff --git a/documentation/resources/footer.png b/documentation/resources/footer.png
new file mode 100644
index 0000000..d99890c
Binary files /dev/null and b/documentation/resources/footer.png differ
diff --git a/documentation/resources/inherit.png b/documentation/resources/inherit.png
new file mode 100644
index 0000000..957079b
Binary files /dev/null and b/documentation/resources/inherit.png differ
diff --git a/documentation/resources/resize.png b/documentation/resources/resize.png
new file mode 100644
index 0000000..fb98a7a
Binary files /dev/null and b/documentation/resources/resize.png differ
diff --git a/documentation/resources/sort.png b/documentation/resources/sort.png
new file mode 100644
index 0000000..0d0fea1
Binary files /dev/null and b/documentation/resources/sort.png differ
diff --git a/documentation/resources/style.css b/documentation/resources/style.css
new file mode 100644
index 0000000..0d35c21
--- /dev/null
+++ b/documentation/resources/style.css
@@ -0,0 +1,614 @@
+body {
+ font: 13px/1.5 Verdana, 'Geneva CE', lucida, sans-serif;
+ margin: 0;
+ padding: 0;
+ background: #ffffff;
+ color: #333333;
+}
+
+h1, h2, h3, h4, caption {
+ font-family: 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
+ color: #053368;
+}
+
+h1 {
+ color: #1e5eb6;
+ font-size: 230%;
+ font-weight: normal;
+ margin: .3em 0;
+}
+
+h2 {
+ color: #1e5eb6;
+ font-size: 150%;
+ font-weight: normal;
+ margin: -.3em 0 .3em 0;
+}
+
+h3 {
+ font-size: 1.6em;
+ font-weight: normal;
+ margin-bottom: 2px;
+}
+
+h4 {
+ font-size: 100%;
+ font-weight: bold;
+ padding: 0;
+ margin: 0;
+}
+
+caption {
+ border: 1px solid #cccccc;
+ background: #ecede5;
+ font-weight: bold;
+ font-size: 1.2em;
+ padding: 3px 5px;
+ text-align: left;
+ margin-bottom: 0;
+}
+
+p {
+ margin: .7em 0 1em;
+ padding: 0;
+}
+
+hr {
+ margin: 2em 0 1em;
+ border: none;
+ border-top: 1px solid #cccccc;
+ height: 0;
+}
+
+a {
+ color: #006aeb;
+ padding: 3px 1px;
+ text-decoration: none;
+}
+
+h1 a {
+ color: #1e5eb6;
+}
+
+a:hover, a:active, a:focus, a:hover b, a:hover var {
+ background-color: #006aeb;
+ color: #ffffff !important;
+}
+
+code, var, pre {
+ font-family: monospace;
+}
+
+var {
+ font-weight: bold;
+ font-style: normal;
+ color: #ca8a04;
+}
+
+pre {
+ margin: 0;
+}
+
+code a b {
+ color: #000000;
+}
+
+.deprecated {
+ text-decoration: line-through;
+ opacity: .5;
+}
+
+.invalid {
+ color: #e71818;
+}
+
+.hidden {
+ display: none;
+}
+
+/* Left side */
+#left {
+ overflow: auto;
+ width: 270px;
+ height: 100%;
+ position: fixed;
+}
+
+/* Menu */
+#menu {
+ padding: 10px;
+}
+
+#menu ul {
+ list-style: none;
+ padding: 0;
+ margin: 0;
+}
+
+#menu ul ul {
+ padding-left: 10px;
+}
+
+#menu li {
+ white-space: nowrap;
+ position: relative;
+}
+
+#menu a {
+ display: block;
+ padding: 0 2px;
+}
+
+#menu .active > a, #menu > span {
+ color: #333333;
+ background: none;
+ font-weight: bold;
+}
+
+#menu .active > a.invalid {
+ color: #e71818;
+}
+
+#menu .active > a:hover, #menu .active > a:active, #menu .active > a:focus {
+ background-color: #006aeb;
+}
+
+#menu #groups span {
+ position: absolute;
+ top: 4px;
+ right: 2px;
+ cursor: pointer;
+ display: block;
+ width: 12px;
+ height: 12px;
+ background: url('collapsed.png') transparent 0 0 no-repeat;
+}
+
+#menu #groups span:hover {
+ background-position: -12px 0;
+}
+
+#menu #groups span.collapsed {
+ background-position: 0 -12px;
+}
+
+#menu #groups span.collapsed:hover {
+ background-position: -12px -12px;
+}
+
+#menu #groups ul.collapsed {
+ display: none;
+}
+
+/* Right side */
+#right {
+ overflow: auto;
+ margin-left: 275px;
+ height: 100%;
+ position: relative;
+ left: 0;
+ right: 0;
+}
+
+#rightInner {
+ max-width: 1000px;
+ min-width: 350px;
+}
+
+/* Search */
+#search {
+ float: right;
+ margin: 3px 8px;
+}
+
+#search input.text {
+ padding: 3px 5px;
+ width: 250px;
+}
+
+/* Autocomplete */
+.ac_results {
+ padding: 0;
+ border: 1px solid #cccccc;
+ background-color: #ffffff;
+ overflow: hidden;
+ z-index: 99999;
+}
+
+.ac_results ul {
+ width: 100%;
+ list-style-position: outside;
+ list-style: none;
+ padding: 0;
+ margin: 0;
+}
+
+.ac_results li {
+ margin: 0;
+ padding: 2px 5px;
+ cursor: default;
+ display: block;
+ font: 12px 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
+ line-height: 16px;
+ overflow: hidden;
+ white-space: nowrap;
+}
+
+.ac_results li strong {
+ color: #000000;
+}
+
+.ac_odd {
+ background-color: #eeeeee;
+}
+
+.ac_over {
+ background-color: #006aeb;
+ color: #ffffff;
+}
+
+.ac_results li.ac_over strong {
+ color: #ffffff;
+}
+
+/* Navigation */
+#navigation {
+ padding: 3px 8px;
+ background-color: #f6f6f4;
+ height: 26px;
+}
+
+#navigation ul {
+ list-style: none;
+ margin: 0 8px 4px 0;
+ padding: 0;
+ overflow: hidden;
+ float: left;
+}
+
+#navigation ul + ul {
+ border-left: 1px solid #000000;
+ padding-left: 8px;
+}
+
+#navigation ul li {
+ float: left;
+ margin: 2px;
+ padding: 0 3px;
+ font-family: Verdana, 'Geneva CE', lucida, sans-serif;
+ color: #808080;
+}
+
+#navigation ul li.active {
+ background-color: #053368;
+ color: #ffffff;
+ font-weight: bold;
+}
+
+#navigation ul li a {
+ color: #000000;
+ font-weight: bold;
+ padding: 0;
+}
+
+#navigation ul li span {
+ float: left;
+ padding: 0 3px;
+}
+
+#navigation ul li a:hover span, #navigation ul li a:active span, #navigation ul li a:focus span {
+ background-color: #006aeb;
+}
+
+/* Content */
+#content {
+ clear: both;
+ padding: 5px 15px;
+}
+
+.description pre {
+ padding: .6em;
+ background: #fcfcf7;
+}
+
+#content > .description {
+ background: #ecede5;
+ padding: 1px 8px;
+ margin: 1.2em 0;
+}
+
+#content > .description pre {
+ margin: .5em 0;
+}
+
+dl.tree {
+ margin: 1.2em 0;
+}
+
+dl.tree dd {
+ margin: 0;
+ padding: 0;
+}
+
+.info {
+ margin: 1.2em 0;
+}
+
+.summary {
+ border: 1px solid #cccccc;
+ border-collapse: collapse;
+ font-size: 1em;
+ width: 100%;
+ margin: 1.2em 0 2.4em;
+}
+
+.summary caption {
+ border-width: 1px 1px 0;
+}
+
+.summary caption.switchable {
+ background: #ecede5 url('sort.png') no-repeat center right;
+ cursor: pointer;
+}
+
+.summary td {
+ border: 1px solid #cccccc;
+ margin: 0;
+ padding: 3px 10px;
+ font-size: 1em;
+ vertical-align: top;
+}
+
+.summary td:first-child {
+ text-align: right;
+}
+
+.summary td hr {
+ margin: 3px -10px;
+}
+
+#packages.summary td:first-child, #namespaces.summary td:first-child, .inherited.summary td:first-child, .used.summary td:first-child {
+ text-align: left;
+}
+
+.summary tr:hover td {
+ background: #f6f6f4;
+}
+
+.summary .description pre {
+ border: .5em solid #ecede5;
+}
+
+.summary .description p {
+ margin: 0;
+}
+
+.summary .description p + p, .summary .description ul {
+ margin: 3px 0 0 0;
+}
+
+.summary .description.detailed h4 {
+ margin-top: 3px;
+}
+
+.summary dl {
+ margin: 0;
+}
+
+.summary dd {
+ margin: 0 0 0 25px;
+}
+
+.name, .attributes {
+ white-space: nowrap;
+}
+
+.value code {
+ white-space: pre-wrap;
+}
+
+td.name, td.attributes {
+ width: 1%;
+}
+
+td.attributes {
+ width: 1%;
+}
+
+.class .methods .name, .class .properties .name, .class .constants .name {
+ width: auto;
+ white-space: normal;
+}
+
+.class .methods .name > div > code {
+ white-space: pre-wrap;
+}
+
+.class .methods .name > div > code span, .function .value > code {
+ white-space: nowrap;
+}
+
+.class .methods td.name > div, .class td.value > div {
+ position: relative;
+ padding-right: 1em;
+}
+
+.anchor {
+ position: absolute;
+ top: 0;
+ right: 0;
+ line-height: 1;
+ font-size: 85%;
+ margin: 0;
+ color: #006aeb !important;
+}
+
+.list {
+ margin: 0 0 5px 25px;
+}
+
+div.invalid {
+ background-color: #fae4e0;
+ padding: 10px;
+}
+
+/* Splitter */
+#splitter {
+ position: fixed;
+ height: 100%;
+ width: 5px;
+ left: 270px;
+ background: #1e5eb6 url('resize.png') left center no-repeat;
+ cursor: e-resize;
+}
+
+#splitter.active {
+ opacity: .5;
+}
+
+/* Footer */
+#footer {
+ border-top: 1px solid #e9eeef;
+ clear: both;
+ color: #a7a7a7;
+ font-size: 8pt;
+ text-align: center;
+ padding: 20px 0 0;
+ margin: 3em 0 0;
+ height: 90px;
+ background: #ffffff url('footer.png') no-repeat center top;
+}
+
+/* Tree */
+div.tree ul {
+ list-style: none;
+ background: url('tree-vertical.png') left repeat-y;
+ padding: 0;
+ margin-left: 20px;
+}
+
+div.tree li {
+ margin: 0;
+ padding: 0;
+}
+
+div.tree div {
+ padding-left: 30px;
+}
+
+div.tree div.notlast {
+ background: url('tree-hasnext.png') left 10px no-repeat;
+}
+
+div.tree div.last {
+ background: url('tree-last.png') left -240px no-repeat;
+}
+
+div.tree li.last {
+ background: url('tree-cleaner.png') left center repeat-y;
+}
+
+div.tree span.padding {
+ padding-left: 15px;
+}
+
+/* Source code */
+.php-keyword1 {
+ color: #e71818;
+ font-weight: bold;
+}
+
+.php-keyword2 {
+ font-weight: bold;
+}
+
+.php-var {
+ color: #d59401;
+ font-weight: bold;
+}
+
+.php-num {
+ color: #cd0673;
+}
+
+.php-quote {
+ color: #008000;
+}
+
+.php-comment {
+ color: #929292;
+}
+
+.xlang {
+ color: #ff0000;
+ font-weight: bold;
+}
+
+span.l {
+ display: block;
+}
+
+span.l.selected {
+ background: #f6f6f4;
+}
+
+span.l a {
+ color: #333333;
+}
+
+span.l a:hover, div.l a:active, div.l a:focus {
+ background: transparent;
+ color: #333333 !important;
+}
+
+span.l .php-var a {
+ color: #d59401;
+}
+
+span.l .php-var a:hover, span.l .php-var a:active, span.l .php-var a:focus {
+ color: #d59401 !important;
+}
+
+span.l a.l {
+ padding-left: 2px;
+ color: #c0c0c0;
+}
+
+span.l a.l:hover, span.l a.l:active, span.l a.l:focus {
+ background: transparent;
+ color: #c0c0c0 !important;
+}
+
+#rightInner.medium #navigation {
+ height: 52px;
+}
+
+#rightInner.medium #navigation ul:first-child + ul {
+ clear: left;
+ border: none;
+ padding: 0;
+}
+
+#rightInner.medium .name, #rightInner.medium .attributes {
+ white-space: normal;
+}
+
+#rightInner.small #search {
+ float: left;
+}
+
+#rightInner.small #navigation {
+ height: 78px;
+}
+
+#rightInner.small #navigation ul:first-child {
+ clear: both;
+}
+
+/* global style */
+.left, .summary td.left {
+ text-align: left;
+}
+.right, .summary td.right {
+ text-align: right;
+}
diff --git a/documentation/resources/tree-cleaner.png b/documentation/resources/tree-cleaner.png
new file mode 100644
index 0000000..2eb9085
Binary files /dev/null and b/documentation/resources/tree-cleaner.png differ
diff --git a/documentation/resources/tree-hasnext.png b/documentation/resources/tree-hasnext.png
new file mode 100644
index 0000000..91d6b79
Binary files /dev/null and b/documentation/resources/tree-hasnext.png differ
diff --git a/documentation/resources/tree-last.png b/documentation/resources/tree-last.png
new file mode 100644
index 0000000..7f319f8
Binary files /dev/null and b/documentation/resources/tree-last.png differ
diff --git a/documentation/resources/tree-vertical.png b/documentation/resources/tree-vertical.png
new file mode 100644
index 0000000..384908b
Binary files /dev/null and b/documentation/resources/tree-vertical.png differ
diff --git a/documentation/source-class-PhpGpio.Gpio.html b/documentation/source-class-PhpGpio.Gpio.html
new file mode 100644
index 0000000..ba0c550
--- /dev/null
+++ b/documentation/source-class-PhpGpio.Gpio.html
@@ -0,0 +1,372 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.GpioDevelop.html b/documentation/source-class-PhpGpio.GpioDevelop.html
new file mode 100644
index 0000000..1204af1
--- /dev/null
+++ b/documentation/source-class-PhpGpio.GpioDevelop.html
@@ -0,0 +1,259 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.GpioInterface.html b/documentation/source-class-PhpGpio.GpioInterface.html
new file mode 100644
index 0000000..e1ddd1b
--- /dev/null
+++ b/documentation/source-class-PhpGpio.GpioInterface.html
@@ -0,0 +1,215 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.Pi.html b/documentation/source-class-PhpGpio.Pi.html
new file mode 100644
index 0000000..1db2131
--- /dev/null
+++ b/documentation/source-class-PhpGpio.Pi.html
@@ -0,0 +1,175 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.Sensors.DS18B20.html b/documentation/source-class-PhpGpio.Sensors.DS18B20.html
new file mode 100644
index 0000000..3251ac1
--- /dev/null
+++ b/documentation/source-class-PhpGpio.Sensors.DS18B20.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.Sensors.MCP3002.html b/documentation/source-class-PhpGpio.Sensors.MCP3002.html
new file mode 100644
index 0000000..2ca00d8
--- /dev/null
+++ b/documentation/source-class-PhpGpio.Sensors.MCP3002.html
@@ -0,0 +1,192 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/source-class-PhpGpio.Sensors.SensorInterface.html b/documentation/source-class-PhpGpio.Sensors.SensorInterface.html
new file mode 100644
index 0000000..362112e
--- /dev/null
+++ b/documentation/source-class-PhpGpio.Sensors.SensorInterface.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/logs/.gitkeep b/logs/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/src/PhpGpio/Camera.php b/src/PhpGpio/Camera.php
new file mode 100644
index 0000000..b48bc60
--- /dev/null
+++ b/src/PhpGpio/Camera.php
@@ -0,0 +1,628 @@
+setCommand(sprintf(
+ "%s %s ",
+ 'raspistill --nopreview -o /opt/temp/test01.jpg'
+
+ $this->quality,
+ $this->width,
+ $this->height,
+ $this->verbose,
+ $this->timeout,
+ $this->encoding,
+ $this->timelapse,
+ $this->sharpness,
+ $this->contrast,
+ $this->saturation,
+ $this->ISO,
+ $this->vstab.$ev.$exposure.$awb.$imxfx.$colfx.$metering.$rotation.$hflip.$vflip.' 2>&1 ' ;
+
+ $escaped_command = escapeshellcmd($command);
+ exec($command, $test, $retval);
+ }
+
+ /**
+ * Gets the value of width.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getWidth()
+ {
+ return $this->width;
+ }
+
+ /**
+ * Sets the value of width.
+ *
+ * @access public
+ * @param mixed $width the width
+ *
+ * @return self
+ */
+ public function setWidth($width)
+ {
+ $this->width = $width;
+ return $this;
+ }
+
+ /**
+ * Gets the value of height.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getHeight()
+ {
+ return $this->height;
+ }
+
+ /**
+ * Sets the value of height.
+ *
+ * @access public
+ * @param mixed $height the height
+ *
+ * @return self
+ */
+ public function setHeight($height)
+ {
+ $this->height = $height;
+ return $this;
+ }
+
+ /**
+ * Gets the value of quality.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getQuality()
+ {
+ return $this->quality;
+ }
+
+ /**
+ * Sets the value of quality.
+ *
+ * @access public
+ * @param mixed $quality the quality
+ *
+ * @return self
+ */
+
+ public function setQuality($quality)
+ {
+ $this->quality = $quality;
+ return $this;
+ }
+ /**
+ * Gets the value of verbose.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getVerbose()
+ {
+ return $this->verbose;
+ }
+
+ /**
+ * Sets the value of verbose.
+ *
+ * @access public
+ * @param mixed $verbose the verbose
+ *
+ * @return self
+ */
+
+ public function setVerbose($verbose)
+ {
+ $this->verbose = $verbose;
+ return $this;
+ }
+ /**
+ * Gets the value of timeout.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getTimeout()
+ {
+ return $this->timeout;
+ }
+
+ /**
+ * Sets the value of timeout.
+ *
+ * @access public
+ * @param mixed $timeout the timeout
+ *
+ * @return self
+ */
+ public function setTimeout($timeout)
+ {
+ $this->timeout = $timeout;
+ return $this;
+ }
+ /**
+ * Gets the value of encoding.
+ *
+ * @access public
+ * @return mixed
+ */
+
+ public function getEncoding()
+ {
+ return $this->encoding;
+ }
+
+ /**
+ * Sets the value of encoding.
+ *
+ * @access public
+ * @param mixed $encoding the encoding
+ *
+ * @return self
+ */
+ public function setEncoding($encoding)
+ {
+ $this->encoding = $encoding;
+ return $this;
+ }
+
+ /**
+ * Gets the value of timelapse.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getTimelapse()
+ {
+ return $this->timelapse;
+ }
+
+ /**
+ * Sets the value of timelapse.
+ *
+ * @access public
+ * @param mixed $timelapse the timelapse
+ *
+ * @return self
+ */
+ public function setTimelapse($timelapse)
+ {
+ $this->timelapse = $timelapse;
+ return $this;
+ }
+
+ /**
+ * Gets the value of sharpness.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getSharpness()
+ {
+ return $this->sharpness;
+ }
+
+ /**
+ * Sets the value of sharpness.
+ *
+ * @access public
+ * @param mixed $sharpness the sharpness
+ *
+ * @return self
+ */
+ public function setSharpness($sharpness)
+ {
+ $this->sharpness = $sharpness;
+ return $this;
+ }
+ /**
+ * Gets the value of contrast.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getContrast()
+ {
+ return $this->contrast;
+ }
+
+ /**
+ * Sets the value of contrast.
+ *
+ * @access public
+ * @param mixed $contrast the contrast
+ *
+ * @return self
+ */
+ public function setContrast($contrast)
+ {
+ $this->contrast = $contrast;
+ return $this;
+ }
+
+ /**
+ * Gets the value of saturation.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getSaturation()
+ {
+ return $this->saturation;
+ }
+
+ /**
+ * Sets the value of saturation.
+ *
+ * @access public
+ * @param mixed $saturation the saturation
+ *
+ * @return self
+ */
+ public function setSaturation($saturation)
+ {
+ $this->saturation = $saturation;
+ return $this;
+ }
+
+ /**
+ * Gets the value of ISO.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getISO()
+ {
+ return $this->ISO;
+ }
+
+ /**
+ * Sets the value of ISO.
+ *
+ * @access public
+ * @param mixed $ISO the i s o
+ * @return self
+ */
+ public function setISO($ISO)
+ {
+ $this->ISO = $ISO;
+ return $this;
+ }
+
+ /**
+ * Gets the value of vstab.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getVstab()
+ {
+ return $this->vstab;
+ }
+
+ /**
+ * Sets the value of vstab.
+ *
+ * @access public
+ * @param mixed $vstab the vstab
+ *
+ * @return self
+ */
+ public function setVstab($vstab)
+ {
+ $this->vstab = $vstab;
+ return $this;
+ }
+
+ /**
+ * Gets the value of ev.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getEv()
+ {
+ return $this->ev;
+ }
+
+ /**
+ * Sets the value of ev.
+ *
+ * @access public
+ * @param mixed $ev the ev
+ *
+ * @return self
+ */
+ public function setEv($ev)
+ {
+ $this->ev = $ev;
+ return $this;
+ }
+
+ /**
+ * Gets the value of exposure.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getExposure()
+ {
+ return $this->exposure;
+ }
+
+ /**
+ * Sets the value of exposure.
+ *
+ * @access public
+ * @param mixed $exposure the exposure
+ *
+ * @return self
+ */
+ public function setExposure($exposure)
+ {
+ $this->exposure = $exposure;
+ return $this;
+ }
+
+ /**
+ * Gets the value of awb.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getAwb()
+ {
+ return $this->awb;
+ }
+
+ /**
+ * Sets the value of awb.
+ *
+ * @access public
+ * @param mixed $awb the awb
+ *
+ * @return self
+ */
+ public function setAwb($awb)
+ {
+ $this->awb = $awb;
+ return $this;
+ }
+
+ /**
+ * Gets the value of imxfx.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getImxfx()
+ {
+ return $this->imxfx;
+ }
+
+ /**
+ * Sets the value of imxfx.
+ *
+ * @access public
+ * @param mixed $imxfx the imxfx
+ *
+ * @return self
+ */
+ public function setImxfx($imxfx)
+ {
+ $this->imxfx = $imxfx;
+ return $this;
+ }
+
+ /**
+ * Gets the value of colfx.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getColfx()
+ {
+ return $this->colfx;
+ }
+
+ /**
+ * Sets the value of colfx.
+ *
+ * @access public
+ * @param mixed $colfx the colfx
+ *
+ * @return self
+ */
+ public function setColfx($colfx)
+ {
+ $this->colfx = $colfx;
+ return $this;
+ }
+
+ /**
+ * Gets the value of metering.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getMetering()
+ {
+ return $this->metering;
+ }
+
+ /**
+ * Sets the value of metering.
+ *
+ * @access public
+ * @param mixed $metering the metering
+ *
+ * @return self
+ */
+ public function setMetering($metering)
+ {
+ $this->metering = $metering;
+ return $this;
+ }
+
+ /**
+ * Gets the value of rotation.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getRotation()
+ {
+ return $this->rotation;
+ }
+
+ /**
+ * Sets the value of rotation.
+ *
+ * @access public
+ * @param mixed $rotation the rotation
+ *
+ * @return self
+ */
+ public function setRotation($rotation)
+ {
+ $this->rotation = $rotation;
+ return $this;
+ }
+
+ /**
+ * Gets the value of hflip.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getHflip()
+ {
+ return $this->hflip;
+ }
+
+ /**
+ * Sets the value of hflip.
+ *
+ * @access public
+ * @param mixed $hflip the hflip
+ *
+ * @return self
+ */
+ public function setHflip($hflip)
+ {
+ $this->hflip = $hflip;
+ return $this;
+ }
+
+ /**
+ * Gets the value of vflip.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getVflip()
+ {
+ return $this->vflip;
+ }
+
+ /**
+ * Sets the value of vflip.
+ *
+ * @access public
+ * @param mixed $vflip the vflip
+ *
+ * @return self
+ */
+ public function setVflip($vflip)
+ {
+ $this->vflip = $vflip;
+ return $this;
+ }
+
+ /**
+ * Gets the value of command.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getCommand()
+ {
+ return $this->command;
+ }
+
+ /**
+ * Sets the value of command.
+ *
+ * @access public
+ * @param mixed $command the command
+ *
+ * @return self
+ */
+ public function setCommand($command)
+ {
+ $this->command = $command;
+ return $this;
+ }
+
+ /**
+ * Gets the value of output.
+ *
+ * @access public
+ * @return mixed
+ */
+ public function getOutput()
+ {
+ return $this->output;
+ }
+
+ /**
+ * Sets the value of output.
+ *
+ * @access public
+ * @param mixed $output the output
+ *
+ * @return self
+ */
+ public function setOutput($output)
+ {
+ $this->output = $output;
+ return $this;
+ }
+}
diff --git a/src/PhpGpio/Gpio.php b/src/PhpGpio/Gpio.php
index eb79e1e..ea802a1 100644
--- a/src/PhpGpio/Gpio.php
+++ b/src/PhpGpio/Gpio.php
@@ -2,6 +2,9 @@
namespace PhpGpio;
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+
class Gpio implements GpioInterface
{
// Using BCM pin numbers.
@@ -9,54 +12,65 @@ class Gpio implements GpioInterface
private $hackablePins;
/**
- * @link http://www.raspberrypi-spy.co.uk/2012/06/simple-guide-to-the-rpi-gpio-header-and-pins/
+ * Class constructor
+ *
+ * @access public
+ * @link http://www.raspberrypi-spy.co.uk/2012/06/simple-guide-to-the-rpi-gpio-header-and-pins/
*/
public function __construct()
{
+ // Raspberry Pi utils?
$raspi = new Pi;
+
+ // Logger
+ $logger = new Logger('Raspberry Pi');
+ $logger->pushHandler(new StreamHandler('logs/'. date('d-m-Y') .'.log', Logger::WARNING));
+
if ($raspi->getVersion() < 4) {
- $this->pins = array(
+ $this->pins = [
0, 1, 4, 7, 8, 9,
10, 11, 14, 15, 17, 18,
21, 22, 23, 24, 25
- );
- $this->hackablePins = array(
+ ];
+ $this->hackablePins = [
4, 7, 8, 9,
10, 11, 17, 18,
21, 22, 23, 24, 25
- );
+ ];
} else if($raspi->getVersion() < 16) {
# new GPIO layout (REV2)
- $this->pins = array(
+ $this->pins = [
2, 3, 4, 7, 8, 9,
10, 11, 14, 15, 17, 18,
22, 23, 24, 25, 27
- );
- $this->hackablePins = array(
+ ];
+ $this->hackablePins = [
4, 7, 8, 9,
10, 11, 17, 18,
22, 23, 24, 25, 27
- );
+ ];
} else {
# new GPIO layout (B+)
- $this->pins = array(
+ $this->pins = [
2, 3, 4, 5, 6, 7,
8, 9, 10, 11, 12, 13,
14, 15, 16, 17, 18, 19,
20, 21, 22, 23, 24, 25,
26, 27
- );
- $this->hackablePins = array(
+ ];
+ $this->hackablePins = [
4, 5, 6,
12, 13, 16, 17, 18, 19,
20, 21, 22, 23, 24, 25, 26, 27
- );
+ ];
}
}
/**
* getHackablePins : the pins you can hack with.
- * @link http://elinux.org/RPi_Low-level_peripherals
+ *
+ * @access public
+ * @link http://elinux.org/RPi_Low-level_peripherals
* @return integer[]
*/
public function getHackablePins()
@@ -64,22 +78,23 @@ public function getHackablePins()
return $this->hackablePins;
}
- private $directions = array(
+ private $directions = [
GpioInterface::DIRECTION_IN,
GpioInterface::DIRECTION_OUT,
- );
+ ];
- private $outputs = array(
+ private $outputs = [
GpioInterface::IO_VALUE_ON,
GpioInterface::IO_VALUE_OFF,
- );
+ ];
// exported pins for when we unexport all
- private $exportedPins = array();
+ private $exportedPins = [ ];
/**
* Setup pin, takes pin number and direction (in or out)
*
+ * @access public
* @param int $pinNo
* @param string $direction
* @return mixed string GPIO value or boolean false
@@ -112,8 +127,10 @@ public function setup($pinNo, $direction)
/**
* Get input value
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
* @return false|string string GPIO value or boolean false
+ * @throws \Exception
*/
public function input($pinNo)
{
@@ -124,6 +141,8 @@ public function input($pinNo)
if ($this->currentDirection($pinNo) != "out") {
return trim(file_get_contents(GpioInterface::PATH_GPIO.$pinNo.'/value'));
}
+
+ $this->logger->addError('Error!' . $this->currentDirection($pinNo) . ' is a wrong direction for this pin!');
throw new \Exception('Error!' . $this->currentDirection($pinNo) . ' is a wrong direction for this pin!');
}
@@ -133,9 +152,11 @@ public function input($pinNo)
/**
* Set output value
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
* @param string $value
- * @return mixed Gpio current instance or boolean false
+ * @return mixed Gpio current instance or boolean false
+ * @throws \Exception
*/
public function output($pinNo, $value)
{
@@ -149,6 +170,7 @@ public function output($pinNo, $value)
if ($this->currentDirection($pinNo) != "in") {
file_put_contents(GpioInterface::PATH_GPIO.$pinNo.'/value', $value);
} else {
+ $this->logger->addError('Error! Wrong Direction for this pin! Meant to be out while it is ' . $this->currentDirection($pinNo));
throw new \Exception('Error! Wrong Direction for this pin! Meant to be out while it is ' . $this->currentDirection($pinNo));
}
}
@@ -159,6 +181,7 @@ public function output($pinNo, $value)
/**
* Unexport Pin
*
+ * @access public
* @param int $pinNo
* @return mixed Gpio current instance or boolean false
*/
@@ -180,6 +203,7 @@ public function unexport($pinNo)
/**
* Unexport all pins
*
+ * @access public
* @return Gpio Gpio current instance or boolean false
*/
public function unexportAll()
@@ -187,7 +211,7 @@ public function unexportAll()
foreach ($this->exportedPins as $pinNo) {
file_put_contents(GpioInterface::PATH_UNEXPORT, $pinNo);
}
- $this->exportedPins = array();
+ $this->exportedPins = [ ];
return $this;
}
@@ -195,6 +219,8 @@ public function unexportAll()
/**
* Check if pin is exported
*
+ * @access public
+ * @param int, $pinNo
* @return boolean
*/
public function isExported($pinNo)
@@ -209,6 +235,8 @@ public function isExported($pinNo)
/**
* get the pin's current direction
*
+ * @access public
+ * @param int, $pinNo
* @return false|string string pin's direction value or boolean false
*/
public function currentDirection($pinNo)
@@ -223,15 +251,19 @@ public function currentDirection($pinNo)
/**
* Check for valid direction, in or out
*
+ * @access public
+ * @param string, $direction
* @exception InvalidArgumentException
- * @return boolean true
+ * @return boolean true
*/
public function isValidDirection($direction)
{
if (!is_string($direction) || empty($direction)) {
+ $this->logger->addError('Direction "%s" is invalid (string expected).', $direction);
throw new \InvalidArgumentException(sprintf('Direction "%s" is invalid (string expected).', $direction));
}
if (!in_array($direction, $this->directions)) {
+ $this->logger->addError('Direction "%s" is invalid (unknown direction).', $direction);
throw new \InvalidArgumentException(sprintf('Direction "%s" is invalid (unknown direction).', $direction));
}
@@ -241,15 +273,19 @@ public function isValidDirection($direction)
/**
* Check for valid output value
*
- * @exception InvalidArgumentException
- * @return boolean true
+ * @access public
+ * @param mixed, $output
+ * @exception InvalidArgumentException.
+ * @return boolean true
*/
public function isValidOutput($output)
{
if (!is_int($output)) {
+ $logger->addError('Pin value "%s" is invalid (integer expected).', $output);
throw new \InvalidArgumentException(sprintf('Pin value "%s" is invalid (integer expected).', $output));
}
if (!in_array($output, $this->outputs)) {
+ $logger->addError('Output value "%s" is invalid (out of exepected range).', $output);
throw new \InvalidArgumentException(sprintf('Output value "%s" is invalid (out of exepected range).', $output));
}
@@ -259,18 +295,30 @@ public function isValidOutput($output)
/**
* Check for valid pin value
*
+ * @access public
+ * @param int, $pinNo
* @exception InvalidArgumentException
- * @return boolean true
+ * @return boolean true
*/
public function isValidPin($pinNo)
{
if (!is_int($pinNo)) {
+ $logger->addError('Pin number "%s" is invalid (integer expected).', $pinNo);
throw new \InvalidArgumentException(sprintf('Pin number "%s" is invalid (integer expected).', $pinNo));
}
if (!in_array($pinNo, $this->pins)) {
+ $logger->addError('Pin number "%s" is invalid (out of exepected range).', $pinNo);
throw new \InvalidArgumentException(sprintf('Pin number "%s" is invalid (out of exepected range).', $pinNo));
}
return true;
}
+
+ public function readValuePin($pinNo) {
+ if (!$this->isValidPin($pinNo)) {
+ return false;
+ }
+
+ return trim(file_get_contents(GpioInterface::PATH_GPIO.$pinNo.'/value'));;
+ }
}
diff --git a/src/PhpGpio/GpioDevelop.php b/src/PhpGpio/GpioDevelop.php
index 6a70305..29d893a 100644
--- a/src/PhpGpio/GpioDevelop.php
+++ b/src/PhpGpio/GpioDevelop.php
@@ -11,29 +11,34 @@
class GpioDevelop implements GpioInterface
{
/**
- * @var array
+ * @access public
+ * @var array
*/
- public $pins = array(14, 15, 17, 18);
+ public $pins = [14, 15, 17, 18];
/**
- * @var array
+ * @access public
+ * @var array
*/
- public $hackablePins = array(17, 18);
+ public $hackablePins = [17, 18];
/**
- * @var int
+ * @access public
+ * @var int
*/
public $inputValue = GpioInterface::IO_VALUE_OFF;
/**
- * @var string
+ * @access public
+ * @var string
*/
public $direction = GpioInterface::DIRECTION_OUT;
/**
* getHackablePins : the pins you can hack with.
- * @link http://elinux.org/RPi_Low-level_peripherals
*
+ * @link http://elinux.org/RPi_Low-level_peripherals
+ * @access public
* @return array
*/
public function getHackablePins()
@@ -44,6 +49,7 @@ public function getHackablePins()
/**
* Setup pin, takes pin number and direction (in or out)
*
+ * @access public
* @param int $pinNo
* @param string $direction
*
@@ -57,6 +63,7 @@ public function setup($pinNo, $direction)
/**
* Get input value
*
+ * @access public
* @param int $pinNo
*
* @return int GPIO value or boolean false
@@ -69,6 +76,7 @@ public function input($pinNo)
/**
* Set output value
*
+ * @access public
* @param int $pinNo
* @param string $value
*
@@ -82,6 +90,7 @@ public function output($pinNo, $value)
/**
* Unexport Pin
*
+ * @access public
* @param int $pinNo
*
* @return GpioDevelop or boolean false
@@ -94,6 +103,7 @@ public function unexport($pinNo)
/**
* Unexport all pins
*
+ * @access public
* @return GpioDevelop or boolean false
*/
public function unexportAll()
@@ -104,7 +114,8 @@ public function unexportAll()
/**
* Check if pin is exported
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return boolean
*/
@@ -116,7 +127,8 @@ public function isExported($pinNo)
/**
* get the pin's current direction
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return string pin's direction value or boolean false
*/
@@ -128,7 +140,8 @@ public function currentDirection($pinNo)
/**
* Check for valid direction, in or out
*
- * @param string $direction
+ * @access public
+ * @param string $direction
*
* @return boolean
*/
@@ -140,7 +153,8 @@ public function isValidDirection($direction)
/**
* Check for valid output value
*
- * @param mixed $output
+ * @access public
+ * @param mixed $output
*
* @return boolean
*/
@@ -152,7 +166,8 @@ public function isValidOutput($output)
/**
* Check for valid pin value
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return boolean
*/
diff --git a/src/PhpGpio/GpioInterface.php b/src/PhpGpio/GpioInterface.php
index 8f07f89..e7508a9 100644
--- a/src/PhpGpio/GpioInterface.php
+++ b/src/PhpGpio/GpioInterface.php
@@ -9,20 +9,21 @@
*/
interface GpioInterface
{
- const DIRECTION_IN = 'in';
+ const DIRECTION_IN = 'in';
const DIRECTION_OUT = 'out';
- const IO_VALUE_ON = 1;
- const IO_VALUE_OFF = 0;
+ const IO_VALUE_ON = 1;
+ const IO_VALUE_OFF = 0;
- const PATH_GPIO = '/sys/class/gpio/gpio';
- const PATH_EXPORT = '/sys/class/gpio/export';
+ const PATH_GPIO = '/sys/class/gpio/gpio';
+ const PATH_EXPORT = '/sys/class/gpio/export';
const PATH_UNEXPORT = '/sys/class/gpio/unexport';
/**
* getHackablePins : the pins you can hack with.
- * @link http://elinux.org/RPi_Low-level_peripherals
*
+ * @access public
+ * @link http://elinux.org/RPi_Low-level_peripherals
* @return array
*/
public function getHackablePins();
@@ -30,6 +31,7 @@ public function getHackablePins();
/**
* Setup pin, takes pin number and direction (in or out)
*
+ * @access public
* @param int $pinNo
* @param string $direction
*
@@ -40,6 +42,7 @@ public function setup($pinNo, $direction);
/**
* Get input value
*
+ * @access public
* @param int $pinNo
*
* @return integer string GPIO value or boolean false
@@ -49,6 +52,7 @@ public function input($pinNo);
/**
* Set output value
*
+ * @access public
* @param int $pinNo
* @param string $value
*
@@ -59,6 +63,7 @@ public function output($pinNo, $value);
/**
* Unexport Pin
*
+ * @access public
* @param int $pinNo
*
* @return GpioDevelop Gpio current instance or boolean false
@@ -68,6 +73,7 @@ public function unexport($pinNo);
/**
* Unexport all pins
*
+ * @access public
* @return GpioDevelop Gpio current instance or boolean false
*/
public function unexportAll();
@@ -75,7 +81,8 @@ public function unexportAll();
/**
* Check if pin is exported
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return boolean
*/
@@ -84,7 +91,8 @@ public function isExported($pinNo);
/**
* get the pin's current direction
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return string string pin's direction value or boolean false
*/
@@ -93,7 +101,8 @@ public function currentDirection($pinNo);
/**
* Check for valid direction, in or out
*
- * @param string $direction
+ * @access public
+ * @param string $direction
*
* @return boolean
*/
@@ -102,7 +111,8 @@ public function isValidDirection($direction);
/**
* Check for valid output value
*
- * @param mixed $output
+ * @access public
+ * @param mixed $output
*
* @return boolean
*/
@@ -111,9 +121,12 @@ public function isValidOutput($output);
/**
* Check for valid pin value
*
- * @param int $pinNo
+ * @access public
+ * @param int $pinNo
*
* @return boolean
*/
public function isValidPin($pinNo);
+
+ public function readValuePin($pinNo);
}
diff --git a/src/PhpGpio/Pi.php b/src/PhpGpio/Pi.php
index 413d1e6..12ba2da 100644
--- a/src/PhpGpio/Pi.php
+++ b/src/PhpGpio/Pi.php
@@ -5,12 +5,13 @@
class Pi
{
/**
- *
+ *
* Get RaspberryPi version
- *
- * A list of Model and Pi Revision & Hardware Revision Code from '/proc/cpuinfo' is here:
- * @link http://www.raspberrypi-spy.co.uk/2012/09/checking-your-raspberry-pi-board-version/
- *
+ *
+ * A list of Model and Pi Revision & Hardware Revision Code from '/proc/cpuinfo' is here:
+ *
+ * @access public
+ * @link http://www.raspberrypi-spy.co.uk/2012/09/checking-your-raspberry-pi-board-version/
* @return decimal Raspi version
*/
public function getVersion()
@@ -24,36 +25,66 @@ public function getVersion()
return 0;
}
-
+
+ /**
+ * Get the CPu load of the Raspberry.
+ *
+ * @access public
+ * @return string.
+ */
public function getCpuLoad()
{
return sys_getloadavg();
}
-
+
+ /**
+ * Get the Cpu temperature
+ *
+ * @access public
+ * @param $fahrenheit, boolean
+ * @return integer.
+ */
public function getCpuTemp($fahrenheit = false)
{
$cputemp = floatval(file_get_contents('/sys/class/thermal/thermal_zone0/temp'))/1000;
-
- if($fahrenheit)
+
+ if($fahrenheit) {
$cputemp = 1.8* $cputemp+32;
-
+
return $cputemp;
+
+ }
}
-
+
+ /**
+ * Get the temperature of the Graphical Porcessing Unit.
+ *
+ * @access public
+ * @param $fahrenheit, boolean
+ * @return integer.
+ */
public function getGpuTemp($fahrenheit = false)
{
- $gputemp = floatval(str_replace(array('temp=', '\'C'), '', exec('/opt/vc/bin/vcgencmd measure_temp')));
-
- if($fahrenheit)
+ $gputemp = floatval(str_replace(['temp=', '\'C'], '', exec('/opt/vc/bin/vcgencmd measure_temp')));
+
+ if($fahrenheit) {
$gputemp = 1.8* $gputemp+32;
return $gputemp;
+
+ }
}
-
+
+ /**
+ * Get the frequency of the CPU.
+ *
+ * @access public
+ * @return integer
+ */
public function getCpuFrequency()
{
$frequency = floatval(file_get_contents('/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq'))/1000;
-
+
return $frequency;
}
}
diff --git a/src/PhpGpio/Sensors/DS18B20.php b/src/PhpGpio/Sensors/DS18B20.php
index 203906d..4aa7735 100644
--- a/src/PhpGpio/Sensors/DS18B20.php
+++ b/src/PhpGpio/Sensors/DS18B20.php
@@ -2,6 +2,9 @@
namespace PhpGpio\Sensors;
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler
+
/*
* 1-Wire is a device communications bus system designed by Dallas Semiconductor Corp.
* that provides low-speed data, signaling, and power over a single signal.
@@ -10,14 +13,28 @@
* such as digital thermometers and weather instruments.
* (source : http://en.wikipedia.org/wiki/1-Wire)
*/
+
class DS18B20 implements SensorInterface
{
private $bus = null; // ex: '/sys/bus/w1/devices/28-000003ced8f4/w1_slave'
const BASEPATH = '/sys/bus/w1/devices/28-';
+
/**
- * Get-Accesssor
+ * Class Constructor
+ */
+ public function __construct()
+ {
+ // Logger
+ $logger = new Logger('Raspberry Pi');
+ $logger->pushHandler(new StreamHandler('logs/'. date('d-m-Y') .'.log', Logger::WARNING));
+ }
+
+ /**
+ * Get-Accesssor
+ *
+ * @access public
*/
public function getBus()
{
@@ -25,17 +42,22 @@ public function getBus()
}
/**
- * Set-Accesssor
+ * Set-Accesssor
+ *
+ * @access public
+ * @param $value
*/
public function setBus($value)
{
// ? is a non empty string, & a valid file path
if (empty($value) || !is_string($value) || !file_exists($value)) {
+ $logger->addError("$value is not a valid w1 bus path.");
throw new \InvalidArgumentException("$value is not a valid w1 bus path");
}
// ? is a regular w1-bus path on a Raspbery ?
if (!strstr($value, self::BASEPATH)) {
+ $logger->addError("$value does not seem to be a regular w1 bus path");
throw new \InvalidArgumentException("$value does not seem to be a regular w1 bus path");
}
@@ -45,6 +67,7 @@ public function setBus($value)
/**
* Setup
*
+ * @access public
* @return $this
*/
public function __construct()
@@ -60,6 +83,7 @@ public function __construct()
* the directory 28-*** indicates the DS18B20 thermal sensor is wired to the bus
* (28 is the family ID) and the unique ID is a 12-chars numerical digit
*
+ * @access public
* @return string $busPath
*/
public function guessBus()
@@ -76,12 +100,14 @@ public function guessBus()
/**
* Read
*
+ * @access public
* @param array $args
* @return float $value
*/
- public function read($args = array())
+ public function read($args = [ ])
{
if (!is_string($this->bus) || !file_exists($this->bus)) {
+ $logger->addError('No bus file found: please run sudo modprobe w1-gpio; sudo modprobe w1-therm & check the guessBus() method result');
throw new \Exception("No bus file found: please run sudo modprobe w1-gpio; sudo modprobe w1-therm & check the guessBus() method result");
}
$raw = file_get_contents($this->bus);
@@ -94,10 +120,11 @@ public function read($args = array())
/**
* Write
*
- * @param array $args
+ * @access public
+ * @param array $args
* @return boolean
*/
- public function write($args = array())
+ public function write($args = [ ])
{
return false;
}
diff --git a/src/PhpGpio/Sensors/MCP3002.php b/src/PhpGpio/Sensors/MCP3002.php
index e19bf0a..2c8dc7c 100644
--- a/src/PhpGpio/Sensors/MCP3002.php
+++ b/src/PhpGpio/Sensors/MCP3002.php
@@ -13,7 +13,7 @@ class MCP3002 implements SensorInterface {
private $_mosipin;
private $_misopin;
private $_cspin;
-
+
private $_gpio;
/**
@@ -24,14 +24,15 @@ class MCP3002 implements SensorInterface {
* $value = adc->read(array('channel' => 0));
* echo $value;
*
- * @param integer $clockpin The clock (CLK) pin (ex. 11)
- * @param integer $mosipin The Master Out Slave In (MOSI) pin (ex. 10)
- * @param integer $misopin The Master In Slave Out (MISO) pin (ex. 9)
- * @param integer $cspin The Chip Select (CSna) pin (ex. 8)
+ * @access public
+ * @param integer $clockpin The clock (CLK) pin (ex. 11)
+ * @param integer $mosipin The Master Out Slave In (MOSI) pin (ex. 10)
+ * @param integer $misopin The Master In Slave Out (MISO) pin (ex. 9)
+ * @param integer $cspin The Chip Select (CSna) pin (ex. 8)
*/
public function __construct($clockpin, $mosipin, $misopin, $cspin) {
$this->_gpio = new GPIO();
-
+
$this->_clockpin = $clockpin;
$this->_mosipin = $mosipin;
$this->_misopin = $misopin;
@@ -47,21 +48,22 @@ public function __construct($clockpin, $mosipin, $misopin, $cspin) {
* Read the specified channel.
* You should specify the channel (0|1) to read with the channel argument.
*
- * @param array $args
+ * @access public
+ * @param array $args
* @return integer
*/
- public function read($args = array()) {
+ public function read($args = [ ]) {
$channel = $args['channel'];
- if (!is_integer($channel) || !in_array($channel, array(0, 1))) {
+ if (!is_integer($channel) || !in_array($channel, [0, 1])) {
echo $msg = "Only 2 channels are available on a Mcp3002: 0 or 1";
throw new \InvalidArgumentException($msg);
}
-
+
// init comm
$this->_gpio->output($this->_cspin, 1);
$this->_gpio->output($this->_clockpin, 0);
$this->_gpio->output($this->_cspin, 0);
-
+
// channel selection
$cmdout = (6 + $channel) << 5;
for ($i = 0; $i < 3; $i++) {
@@ -74,7 +76,7 @@ public function read($args = array()) {
$this->_gpio->output($this->_clockpin, 1);
$this->_gpio->output($this->_clockpin, 0);
}
-
+
$adcout = 0;
// read in one empty bit, one null bit and 10 ADC bits
for ($i = 0; $i < 12; $i++) {
@@ -85,12 +87,19 @@ public function read($args = array()) {
$adcout |= 0x1;
}
}
-
+
$this->_gpio->output($this->_cspin, 1);
return $adcout >> 1;
}
-
- public function write($args = array()) {
+
+ /**
+ * write
+ *
+ * @access public
+ * @param array, $args
+ * @return boolean
+ */
+ public function write($args = [ ]) {
return false;
}
}
diff --git a/src/PhpGpio/Sensors/SensorInterface.php b/src/PhpGpio/Sensors/SensorInterface.php
index 2d27e7b..decc5aa 100644
--- a/src/PhpGpio/Sensors/SensorInterface.php
+++ b/src/PhpGpio/Sensors/SensorInterface.php
@@ -11,17 +11,19 @@ interface SensorInterface
/**
* Read
*
- * @param array $args
+ * @access public
+ * @param array $args
* @return double
*/
- public function read($args = array());
+ public function read($args = [ ]);
/**
* Write
*
- * @param array $args
+ * @access public
+ * @param array $args
* @return $this
*/
- public function write($args = array());
+ public function write($args = [ ]);
}
diff --git a/tests/PhpGpio/Tests/GpioTest.php b/tests/PhpGpio/Tests/GpioTest.php
index 9e33b60..ca2e81b 100755
--- a/tests/PhpGpio/Tests/GpioTest.php
+++ b/tests/PhpGpio/Tests/GpioTest.php
@@ -4,9 +4,6 @@
use PhpGpio\Gpio;
-/**
- * @author Ronan Guilloux
+
+
+
+
+
+ |