udooneorest 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c05a465947a23bb721af3753d43b51e74349e64
-  data.tar.gz: 279e4c8a58466597bfc76e5eae1929353959d790
+  metadata.gz: 8423f087b238671a8fe5502d8fbf21576baa1d96
+  data.tar.gz: 83933c1d73407f6061f1959a5d8d4a2a3372c872
 SHA512:
-  metadata.gz: 8c7ad84f98bfec09920e7e7b0099666972f77767b90296350b273a777b44604502f6ae0ad429dec6ec5764b275bd8f158d0ea4d62fd1b021b39ddcd24102379c
-  data.tar.gz: b447bdc805ca0875b01aa90f8adf376bebff1e1ab78e105f34f9e83cebd59314e8b92c4f09817111381100f89499e574545963cd0a753a158a8b2ff71b9cfb9c
+  metadata.gz: 9248abf15b708af872b9a35ae9b337a21af46bca99f6fc80a6bdfe3e6b6ad3d4adf8aa02265051caa83602c5e45afa5e14fdc685b21d0fb94726f0e9d81b602d
+  data.tar.gz: ba619decc1c3d2d05510f5b09e4fa9575bef4d5c779a9df008471b56987274b93c246ebc5429e183d00e219091bd36a941249a3e86bb2fa4d49a08b57856a927

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Mark Sullivan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,267 @@
+= UdooNeoREST
+
+This GEM provides REST service for the UDOO NEO GPIO's, the inbuilt motion sensors
+(Accelerometer/Magnetometer/Gyroscope) and the Bricks Snap-in Sensors (Barometer/Temperature)
+
+== Why?
+
+I wanted to be able to easily manipulate and monitor the GPIOs over HTTP.
+
+Why did I choose Ruby when its not installed by default on the UDOO Neo image? No reason other
+than I like coding in Ruby and I have always wanted to give Sinatra a go.
+
+== Before you start
+
+As of the beta5 release of the UDOO Neo Ubunto image, there remains an issue where you will need to make
+a few changes to allow the udooer account to have sufficent rights to interact with the gpios. This
+is discussed in this forum thread (http://www.udoo.org/forum/threads/gpio-through-sys-class.3020/) but I have
+summarized what you need to do here:
+
+1) Edit the file /etc/udev/rules.d/10-imx.rules
+
+    sudo vi /etc/udev/rules.d/10-imx.rules
+
+2) Add the following lines:
+
+    SUBSYSTEM=="gpio", ACTION=="add", PROGRAM="/bin/sh -c 'chown -R root:ugpio /sys%p'"
+    SUBSYSTEM=="gpio", ACTION=="add", PROGRAM="/bin/sh -c 'chmod -R g+rw /sys%p'"
+    SUBSYSTEM=="gpio", ACTION=="add", PROGRAM="/bin/sh -c 'chown -R root:ugpio /sys/class/gpio/export'"
+    SUBSYSTEM=="gpio", ACTION=="add", PROGRAM="/bin/sh -c 'chmod -R g+w /sys/class/gpio/export'"
+
+3) Make the following group/user changes:
+
+    sudo groupadd -r ugpio
+    sudo usermod -a -G ugpio udooer
+
+4) Reboot!
+
+    sudo shutdown -r now
+
+== Installing Ruby
+
+These instructions assume you have a fresh UDOO Neo image.
+
+1) Install RVM
+
+RVM (https://rvm.io) is nice tool to make installing and managing different versions of Ruby easy.
+Its not a 100% requirement, but the instructions below assume RVM is installed.
+
+    $ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
+
+    $ \curl -sSL https://get.rvm.io | bash -s stable
+
+Yes the \ before curl is to be included.
+
+2) Load RVM
+
+Either logout of your ssh session and log back in, or issue the following command to load rvm manually:
+
+    source /home/udooer/.rvm/scripts/rvm
+
+3) Install the latest version of Ruby
+
+    $ rvm install ruby --latest
+
+After a few minutes you will be required to enter the udooer account password:
+
+    udooer password required for 'apt-get --quiet --yes update': <password>
+
+4) Walk away and have a nice beverage of your choosing and come back after watching a rerun of a GoT episode.
+
+
+== Gem Installation
+
+Install the udooneorest gem using rubygems
+
+    $ gem install udooneorest --no-ri --no-rdoc
+
+
+== Starting the REST service
+
+To start the REST service simply issue the command:
+
+    $ udooneorest
+
+
+== The API
+
+I've written the API with two slightly different implementations.
+
+The first is what you would consider a proper RESTful implementation whereby
+creates use POST, updates use PUT and read uses GET.
+
+The second I created because I know many (like me) sometimes would prefer to
+avoid firing up a REST Console when they want some quick data. So my "lazyrest"
+implementation duplicates the API but using gets only (so you can simply use
+your browser).
+
+=== Port
+
+The server listens on 4567 so you can access it in the following way: http://udooneo.local:4567/{api}
+
+=== GPIO versus PIN
+
+The UDOO Neo uses the GPIO in all its commands, but on the board it displays
+the PIN numbers (PCB Names). You can use either the GPIO or the PIN in the
+appropriate API and udooneorest will translate it appropriately.
+
+Details of the GPIO to PIN mappings can be found here: http://www.udoo.org/docs-neo/Hardware_&_Accessories/Gpio.html
+
+=== REST Response
+
+The response to the REST call will be JSON structured in the following format:
+
+    {'status' : 'success|failed', 'message' : 'If it failed, a description of why will be here'}
+
+=== GPIO Services
+
+==== Export
+
+Exporting enables the GPIO if it hasn't been previosly enabled. If you are using
+a specific GPIO for the first time, then you should export it before you will
+be able to set the direction or a value.
+
+If you export a GPIO more than once, the successive export will generate a
+failed response.
+
+==== RESTful
+
+    POST /gpio/{gpio#}/export
+    POST /pin/{pin#}/export
+
+==== Lazyrest
+
+    GET /lazyrest/gpio/{gpio#}/export
+    GET /lazyrest/pin/{pin#}/export
+
+
+==== Direction
+
+To manipulate or read the direction of the GPIO use the following calls.
+
+==== RESTful
+
+    PUT /gpio/{gpio#}/direction/{in|out}
+    PUT /pin/{pin#}/direction/{in|out}
+    GET /gpio/{gpio#}/direction
+    GET /pin/{pin#}/direction
+
+==== Lazyrest
+
+    GET /lazyrest/gpio/{gpio#}/direction/{in|out}
+    GET /lazyrest/pin/{pin#}/direction/{in|out}
+    GET /lazyrest/gpio/{gpio#}/direction
+    GET /lazyrest/pin/{pin#}/direction
+
+
+==== Value
+
+To manipulate or read the value of the GPIO use the following calls. The value can be 0 or 1 (low 0v or high 3v3).
+
+If you try to set the value for a GPIO where the direction is "IN" expect an error.
+
+Also a warning about reading the value, straight from the UDOO Neo GPIO documentation:
+
+"If the direction is set to out and you try to read the value, it is not guaranteed that the kernel value is coherent with the voltage found on the external pinout."
+
+==== RESTful
+
+    PUT /gpio/{gpio#}/value/{0|1}
+    PUT /pin/{pin#}/value/{0|1}
+    GET /gpio/{gpio#}/value
+    GET /pin/{pin#}/value
+
+==== Lazyrest
+
+    GET /lazyrest/gpio/{gpio#}/value/{0|1}
+    GET /lazyrest/pin/{pin#}/value/{0|1}
+    GET /lazyrest/gpio/{gpio#}/value
+    GET /lazyrest/pin/{pin#}/value
+
+=== Motion Sensors
+
+==== Accelerometer
+
+To manipulate and read the Accelerometer use the following calls.
+
+==== RESTful
+
+    PUT /accelerometer/enable
+    PUT /accelerometer/disable
+    GET /accelerometer/value
+
+==== Lazyrest
+
+    GET /lazyrest/accelerometer/enable
+    GET /lazyrest/accelerometer/disable
+    GET /lazyrest/accelerometer/value
+
+
+==== Gyroscope
+
+To manipulate and read the Gyroscope use the following calls.
+
+==== RESTful
+
+    PUT /gyroscope/enable
+    PUT /gyroscope/disable
+    GET /gyroscope/value
+
+==== Lazyrest
+
+    GET /lazyrest/gyroscope/enable
+    GET /lazyrest/gyroscope/disable
+    GET /lazyrest/gyroscope/value
+
+==== Magnetometer
+
+To manipulate and read the Magnetometer use the following calls.
+
+==== RESTful
+
+    PUT /magnetometer/enable
+    PUT /magnetometer/disable
+    GET /magnetometer/value
+
+==== Lazyrest
+
+    GET /lazyrest/magnetometer/enable
+    GET /lazyrest/magnetometer/disable
+    GET /lazyrest/magnetometer/value
+
+
+=== Bricks Snap-in Sensors
+
+==== Temperature
+
+To read the Temperature use the following calls.
+
+==== RESTful
+
+    GET /temperature/value
+    
+==== Lazyrest
+
+    GET /lazyrest/temperature/value
+
+
+==== Barometer
+
+To read the Barometer use the following calls.
+
+==== RESTful
+
+    GET /barometer/value
+
+==== Lazyrest
+
+    GET /lazyrest/barometer/value
+
+=== Example
+
+Here is an example using the API to export gpio 25, set the direction to out and
+finally set the value to 1 (3v3).
+
+    http://udooneo.local:4567/lazyrest/gpio/25/export
+    http://udooneo.local:4567/lazyrest/gpio/25/direction/out
+    http://udooneo.local:4567/lazyrest/gpio/25/value/1

data/lib/udooneorest/value.rb

@@ -96,8 +96,8 @@ module UdooNeoRest
       return gpio_.error_message unless gpio_.valid?
 
       # Validate the value
-      value         = ValidateValue.new value
-      return value.error_message unless value.valid?
+      value_         = ValidateValue.new value
+      return value_.error_message unless value_.valid?
 
       # Send the command and if no error return an OK result
       result         = UdooNeoRest::Base.echo value, "#{BASE_PATH}gpio#{gpio}/value"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: udooneorest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mark Sullivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -33,6 +33,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE.txt
+- README.rdoc
 - bin/udooneorest
 - lib/udooneorest.rb
 - lib/udooneorest/accelerometer.rb
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Rest API for interacting with UDOO Neo