udooneorest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c05a465947a23bb721af3753d43b51e74349e64
+  data.tar.gz: 279e4c8a58466597bfc76e5eae1929353959d790
+SHA512:
+  metadata.gz: 8c7ad84f98bfec09920e7e7b0099666972f77767b90296350b273a777b44604502f6ae0ad429dec6ec5764b275bd8f158d0ea4d62fd1b021b39ddcd24102379c
+  data.tar.gz: b447bdc805ca0875b01aa90f8adf376bebff1e1ab78e105f34f9e83cebd59314e8b92c4f09817111381100f89499e574545963cd0a753a158a8b2ff71b9cfb9c

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "sinatra"

data/bin/udooneorest

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'udooneorest'

data/lib/udooneorest.rb

@@ -0,0 +1,183 @@
+require 'sinatra/base'
+
+require_relative 'udooneorest/validators'
+require_relative 'udooneorest/export'
+require_relative 'udooneorest/value'
+require_relative 'udooneorest/direction'
+require_relative 'udooneorest/gyroscope'
+require_relative 'udooneorest/accelerometer'
+require_relative 'udooneorest/magnetometer'
+require_relative 'udooneorest/barometer'
+require_relative 'udooneorest/temperature'
+
+
+GPIOS             =  %w(106 107 180 181 172 173 182 124 25 22 14 15 16 17 18 19 20 21 203 202 177 176 175 174 119 124 127 116 7 6 5 4)
+HELP_URL          = 'http://github.com/marksull/udooneorest'
+BASE_PATH         = '/sys/class/gpio/'
+VALUE_LOW         = '0'
+VALUE_HIGH        = '1'
+DIRECTION_IN      = 'in'
+DIRECTION_OUT     = 'out'
+FAILED_MESSAGE    = 'failed'
+SUCCESS_MESSAGE   = 'success'
+
+module UdooNeoRest
+
+  class Base < Sinatra::Application
+
+    # Have Sinatra listen on all interfaces
+    set :bind, '0.0.0.0'
+
+    #############################################################################
+    # Message constructor
+    #
+    # status       : the status of the operation
+    # message      : the message to be displayed
+    #
+    def self.status_message(status, message)
+      "{'status' : '#{status}', 'message' : '#{message}'}"
+    end
+
+    #############################################################################
+    # Construct the status message when no errors occurred
+    #
+    # message      : the message to be displayed
+    #
+    def self.status_ok(message = '')
+      status_message(SUCCESS_MESSAGE, message)
+    end
+
+    #############################################################################
+    # Construct the status message when an error occurred
+    #
+    # message      : the message to be displayed
+    #
+    def self.status_error(message)
+      status_message(FAILED_MESSAGE, message)
+    end
+
+    #############################################################################
+    # Echo a value to a file
+    #
+    # value      : the value to echo to the file
+    # file       : the file to echo the value too
+    #
+    def self.echo(value, file)
+      begin
+        File.write(file, value)
+      rescue Errno::EINVAL
+        # close always error on the udoo gpios - cause unknown
+      rescue Exception => e
+        return e.message
+      end
+      ''
+    end
+
+    #############################################################################
+    # Cat a file
+    #
+    # file       : the file to cat
+    #
+    def self.cat(file)
+      File.read(file).chomp
+    end
+
+    #############################################################################
+    # Calculate the Barometer/Temp value from raw and scale values
+    #
+    def self.sensor_calc(sensor)
+      raw   = UdooNeoRest::Base.cat(UdooNeoRest::Base.sensor_path(sensor) + '_raw').to_i
+      scale = UdooNeoRest::Base.cat(UdooNeoRest::Base.sensor_path(sensor) + '_scale').to_f
+      UdooNeoRest::Base.status_ok(raw * scale)
+    end
+
+    #############################################################################
+    # Build the path to common sensors
+    #
+    # sensor       : the sensor name
+    #
+    def self.sensor_path(sensor)
+      "/sys/class/i2c-dev/i2c-1/device/1-0060/iio:device0/in_#{sensor}"
+    end
+
+    #############################################################################
+    # Build the path to common axis sensors
+    #
+    # sensor       : the sensor name
+    #
+    def self.axis_path(sensor)
+      "/sys/class/misc/Freescale#{sensor}"
+    end
+
+    #############################################################################
+    # Build the path to common axis sensors to enable/disable
+    #
+    # sensor       : the sensor name
+    #
+    def self.axis_path_enable(sensor)
+      UdooNeoRest::Base.axis_path(sensor) + '/enable'
+    end
+
+    #############################################################################
+    # Build the path to common axis sensors to retrieve data
+    #
+    # sensor       : the sensor name
+    #
+    def self.axis_path_data(sensor)
+      UdooNeoRest::Base.axis_path(sensor) + '/data'
+    end
+
+    #############################################################################
+    # Cat a file contents and return the status
+    #
+    # file       : the file to cat
+    #
+    def self.cat_and_status(file)
+      UdooNeoRest::Base.status_ok(UdooNeoRest::Base.cat file)
+    end
+
+    #############################################################################
+    # Enable or disable one of the axis sensors
+    #
+    # Value       : 0 disables the axis, 1 enables it
+    #
+    def self.change_state(file, value)
+      result        = UdooNeoRest::Base.echo value, file
+      result.empty? ? UdooNeoRest::Base.status_ok : UdooNeoRest::Base.status_error(result)
+    end
+
+    #############################################################################
+    # Import all the Sinatra routes
+    #
+    use UdooNeoRest::Value
+    use UdooNeoRest::Accelerometer
+    use UdooNeoRest::Barometer
+    use UdooNeoRest::Gyroscope
+    use UdooNeoRest::Magnetometer
+    use UdooNeoRest::Temperature
+    use UdooNeoRest::Export
+    use UdooNeoRest::Direction
+
+    #############################################################################
+    # Show the help documentation
+    #
+    get '/help' do
+      UdooNeoRest::Base.status_ok("Help documentation can be found here: #{HELP_URL}")
+    end
+
+    #############################################################################
+    # Default route to catch incorrect API calls
+    #
+    not_found do
+      UdooNeoRest::Base.status_error("This API call is not know. Please refer to the documentation #{HELP_URL}")
+    end
+  end
+
+end
+
+UdooNeoRest::Base.run!
+
+
+
+
+

data/lib/udooneorest/accelerometer.rb

@@ -0,0 +1,50 @@
+module UdooNeoRest
+
+  class Accelerometer < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    put '/accelerometer/enable' do
+      enable '1'
+    end
+
+    put '/accelerometer/disable' do
+      enable '0'
+    end
+
+    get '/accelerometer/value' do
+      data
+    end
+
+    get '/lazyrest/accelerometer/enable' do
+      enable '1'
+    end
+
+    get '/lazyrest/accelerometer/disable' do
+      enable '0'
+    end
+
+    get '/lazyrest/accelerometer/value' do
+      data
+    end
+
+    #############################################################################
+    # Enable/Disable the Accelerometer
+    #
+    # value         : 0 = Disable, 1 = Enable
+    #
+    def enable(value)
+      UdooNeoRest::Base.change_state UdooNeoRest::Base.axis_path_enable('Accelerometer'), value
+    end
+
+    #############################################################################
+    # Get the value for the Accelerometer
+    #
+    def data
+      UdooNeoRest::Base.cat_and_status UdooNeoRest::Base.axis_path_data('Accelerometer')
+    end
+
+  end
+
+end

data/lib/udooneorest/barometer.rb

@@ -0,0 +1,18 @@
+module UdooNeoRest
+
+  class Barometer  < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    get '/barometer/value' do
+      UdooNeoRest::Base.sensor_calc 'pressure'
+    end
+
+    get '/lazyrest/barometer/value' do
+      UdooNeoRest::Base.sensor_calc 'pressure'
+    end
+
+  end
+
+end

data/lib/udooneorest/direction.rb

@@ -0,0 +1,109 @@
+module UdooNeoRest
+
+  class Direction < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    put '/gpio/:gpio/direction/:direction' do
+      direction_set_gpio params[:gpio], params[:direction]
+    end
+
+    put '/pin/:pin/direction/:direction' do
+      direction_set_pin params[:pin], params[:direction]
+    end
+
+    get '/gpio/:gpio/direction' do
+      direction_get_gpio params[:gpio]
+    end
+
+    get '/pin/:pin/direction' do
+      direction_get_pin params[:pin]
+    end
+
+    get '/lazyrest/gpio/:gpio/direction/:direction' do
+      direction_set_gpio params[:gpio], params[:direction]
+    end
+
+    get '/lazyrest/pin/:pin/direction/:direction' do
+      direction_set_pin params[:pin], params[:direction]
+    end
+
+    get '/lazyrest/gpio/:gpio/direction' do
+      direction_get_gpio params[:gpio]
+    end
+
+    get '/lazyrest/pin/:pin/direction' do
+      direction_get_pin params[:pin]
+    end
+
+    #############################################################################
+    # Get the value for a specific pin
+    #
+    # pin         : the pin to be set (will be translated to GPIO)
+    #
+    def direction_get_pin(pin)
+
+      # Validate the pin
+      pin_ = ValidatePin.new pin
+      return pin_.error_message unless pin_.valid?
+
+      # Get the value after translating to gpio
+      direction_get_gpio pin_.to_gpio
+    end
+
+    #############################################################################
+    # Get the direction for a specific gpio
+    #
+    # gpio         : the gpio to get
+    #
+    def direction_get_gpio(gpio)
+
+      # validate the gpio
+      gpio_          = ValidateGpio.new gpio
+      return gpio_.error_message unless gpio_.valid?
+
+      # get the direction
+      UdooNeoRest::Base.status_ok(UdooNeoRest::Base.cat "#{BASE_PATH}gpio#{gpio}/direction")
+    end
+
+    #############################################################################
+    # Set a specific pin to the nominated direction
+    #
+    # pin         : the pin to be set (will be translated to GPIO)
+    # direction   : the direction to be used
+    #
+    def direction_set_pin(pin, direction)
+
+      # valide the pin
+      pin_ = ValidatePin.new pin
+      return pin_.error_message unless pin_.valid?
+
+      # Set the direction after translating to gpio
+      direction_set_gpio pin_.to_gpio, direction
+    end
+
+    #############################################################################
+    # Set a specific gpio to the nominated direction
+    #
+    # gpio        : the gpio to be set
+    # direction   : the direction to be used
+    #
+    def direction_set_gpio(gpio, direction)
+
+      # validate the gpio
+      gpio_          = ValidateGpio.new gpio
+      return gpio_.error_message unless gpio_.valid?
+
+      # validate the direction
+      direction_     = ValidateDirection.new direction
+      return direction_.error_message unless direction_.valid?
+
+      # Send the command and if no error return an OK result else return the error
+      result         = UdooNeoRest::Base.echo direction, "#{BASE_PATH}gpio#{gpio}/direction"
+      result.empty? ? UdooNeoRest::Base.status_ok : UdooNeoRest::Base.status_error(result)
+    end
+
+  end
+
+end

data/lib/udooneorest/export.rb

@@ -0,0 +1,67 @@
+module UdooNeoRest
+
+  class Export  < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    post '/gpio/:gpio/export' do
+      export_gpio params[:gpio]
+    end
+
+    post '/pin/:pin/export' do
+      export_pin params[:pin]
+    end
+
+    get '/lazyrest/gpio/:gpio/export' do
+      export_gpio params[:gpio]
+    end
+
+    get '/lazyrest/pin/:pin/export' do
+      export_pin params[:pin]
+    end
+
+    #############################################################################
+    # Export using the pin
+    #
+    # pin     : the pin to be exported
+    #
+    def export_pin(pin)
+
+      # Validate the pin
+      pin_ = ValidatePin.new pin
+      return pin_.error_message unless pin_.valid?
+
+      # Export the value after translating to gpio
+      export_gpio pin_.to_gpio
+    end
+
+    #############################################################################
+    # Export using the gpio
+    #
+    # gpio     : the gpio to be exported
+    #
+    def export_gpio(gpio)
+
+      # lets make sure the gpio is good
+      gpio_          = ValidateGpio.new gpio
+      return gpio_.error_message unless gpio_.valid?
+
+      # send the command
+      result         = UdooNeoRest::Base.echo gpio, "#{BASE_PATH}export"
+
+      # return ok if all is well
+      return UdooNeoRest::Base.status_ok if result.empty?
+
+      # provide some constructive feedback on the root cause of this specific error
+      if result =~ /resource busy/
+        return UdooNeoRest::Base.status_error('Resource Busy error occurred. Maybe the gpio has already been exported. It only needs to be exported once.')
+      end
+
+      # otherwise just return the error
+      UdooNeoRest::Base.status_error(result)
+    end
+
+  end
+
+end

data/lib/udooneorest/gyroscope.rb

@@ -0,0 +1,50 @@
+module UdooNeoRest
+
+  class Gyroscope < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    put '/gyroscope/enable' do
+      enable '1'
+    end
+
+    put '/gyroscope/disable' do
+      enable '0'
+    end
+
+    get '/gyroscope/value' do
+      data
+    end
+
+    get '/lazyrest/gyroscope/enable' do
+      enable '1'
+    end
+
+    get '/lazyrest/gyroscope/disable' do
+      enable '0'
+    end
+
+    get '/lazyrest/gyroscope/value' do
+      data
+    end
+
+    #############################################################################
+    # Enable/Disable the Gyroscope
+    #
+    # value         : 0 = Disable, 1 = Enable
+    #
+    def enable(value)
+      UdooNeoRest::Base.change_state UdooNeoRest::Base.axis_path_enable('Gyroscope'), value
+    end
+
+    #############################################################################
+    # Get the value for the Gyroscope
+    #
+    def data
+      UdooNeoRest::Base.cat_and_status UdooNeoRest::Base.axis_path_data('Gyroscope')
+    end
+
+  end
+
+end

data/lib/udooneorest/magnetometer.rb

@@ -0,0 +1,50 @@
+module UdooNeoRest
+
+  class Magnetometer < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    put '/magnetometer/enable' do
+      enable '1'
+    end
+
+    put '/magnetometer/disable' do
+      enable '0'
+    end
+
+    get '/magnetometer/value' do
+      data
+    end
+
+    get '/lazyrest/magnetometer/enable' do
+      enable '1'
+    end
+
+    get '/lazyrest/magnetometer/disable' do
+      enable '0'
+    end
+
+    get '/lazyrest/magnetometer/value' do
+      data
+    end
+
+    #############################################################################
+    # Enable/Disable the magnetometer
+    #
+    # value         : 0 = Disable, 1 = Enable
+    #
+    def enable(value)
+      UdooNeoRest::Base.change_state UdooNeoRest::Base.axis_path_enable('Magnetometer'), value
+    end
+
+    #############################################################################
+    # Get the value for the magnetometer
+    #
+    def data
+      UdooNeoRest::Base.cat_and_status UdooNeoRest::Base.axis_path_data('Magnetometer')
+    end
+
+  end
+
+end

data/lib/udooneorest/temperature.rb

@@ -0,0 +1,18 @@
+module UdooNeoRest
+
+  class Temperature  < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    get '/temperature/value' do
+      UdooNeoRest::Base.sensor_calc 'temp'
+    end
+
+    get '/lazyrest/temperature/value' do
+      UdooNeoRest::Base.sensor_calc 'temp'
+    end
+
+  end
+
+end

data/lib/udooneorest/validators.rb

@@ -0,0 +1,119 @@
+module UdooNeoRest
+
+  #############################################################################
+  # Base validation class. Override the valid? method
+  #
+  # value       : the value to be validated
+  #
+  class Validate
+
+    attr_reader :error_message
+    attr_accessor :value
+
+    def initialize(value)
+      @value          = value
+      @error_message  = nil
+      valid?
+    end
+
+    def valid?
+      raise 'SubclassShouldOverrideValid'
+    end
+
+  end
+
+  #############################################################################
+  # Validate the Direction parameter
+  #
+  # value       : the direction value to be validated
+  #
+  class ValidateDirection < Validate
+
+    def valid?
+      if (@value != DIRECTION_IN ) && (@value != DIRECTION_OUT)
+        @error_message = UdooNeoRest::Base.status_error("Direction value of '#{@value}' is invalid. Should only be 'in' or 'out'.")
+        return false
+      end
+
+      @error_message  = nil
+      true
+    end
+
+  end
+
+  #############################################################################
+  # Validate the GPIO parameter
+  #
+  # value       : the gpio value to be validated
+  #
+  class ValidateGpio < Validate
+
+    def valid?
+      unless GPIOS.include?(@value)
+        @error_message = UdooNeoRest::Base.status_error("GPIO value of '#{@value}' is invalid. Should be one of #{GPIOS.sort.join(',')}.")
+        return false
+      end
+
+      @error_message  = nil
+      true
+    end
+
+  end
+
+  #############################################################################
+  # Validate the Value parameter
+  #
+  # value       : the value to be validated
+  #
+  class ValidateValue < Validate
+
+    def valid?
+      if (@value != VALUE_LOW ) && (@value != VALUE_HIGH)
+        @error_message = UdooNeoRest::Base.status_error("Value of '#{@value}' is invalid. Should be one of #{VALUE_LOW} or #{VALUE_HIGH}.")
+        return false
+      end
+
+      @error_message  = nil
+      true
+    end
+
+  end
+
+  #############################################################################
+  # Validate the Pin parameter
+  #
+  # value       : the pin value to be validated
+  #
+  class ValidatePin < Validate
+
+    def initialize(value)
+      @value          = value.to_i
+      @error_message  = nil
+      valid?
+    end
+
+    def valid?
+      if (16 > @value || @value > 47)
+        @error_message = UdooNeoRest::Base.status_error("Pin value of '#{@value}' is invalid. Should be between >=16 and <=47.")
+        return false
+      end
+
+      @error_message  = nil
+      true
+    end
+
+    ###########################################################################
+    # Convert a PIN reference to a GPIO reference as all the commands use GPIO
+    #
+    def to_gpio
+      return nil unless valid?
+      GPIOS[@value-16]
+    end
+
+  end
+  
+end
+
+
+
+

data/lib/udooneorest/value.rb

@@ -0,0 +1,117 @@
+module UdooNeoRest
+
+  class Value  < Sinatra::Application
+
+    #############################################################################
+    # Routes
+    #
+    put '/gpio/:gpio/value/:value' do
+      value_set_gpio params[:gpio], params[:value]
+    end
+
+    put '/pin/:pin/value/:value' do
+      value_set_pin params[:pin], params[:value]
+    end
+
+    get '/gpio/:gpio/value' do
+      value_get_gpio params[:gpio]
+    end
+
+    get '/pin/:pin/value' do
+      value_get_pin params[:pin]
+    end
+
+    get '/lazyrest/gpio/:gpio/value/:value' do
+      value_set_gpio params[:gpio], params[:value]
+    end
+
+    get '/lazyrest/pin/:pin/value/:value' do
+      value_set_pin params[:pin], params[:value]
+    end
+
+    get '/lazyrest/gpio/:gpio/value' do
+      value_get_gpio params[:gpio]
+    end
+
+    get '/lazyrest/pin/:pin/value' do
+      value_get_pin params[:pin]
+    end
+
+    #############################################################################
+    # Get the value for a specific pin
+    #
+    # pin         : the pin to be set (will be translated to GPIO)
+    #
+    def value_get_pin(pin)
+
+      # Validate the pin
+      pin_ = ValidatePin.new pin
+      return pin_.error_message unless pin_.valid?
+
+      # Get the value after translating to gpio
+      value_get_gpio pin_.to_gpio
+    end
+
+    #############################################################################
+    # Get the value for a specific gpio
+    #
+    # gpio         : the gpio to get
+    #
+    def value_get_gpio(gpio)
+
+      # Validate the gpio
+      gpio_ = ValidateGpio.new gpio
+      return gpio_.error_message unless gpio_.valid?
+
+      # Get the value
+      UdooNeoRest::Base.status_ok(UdooNeoRest::Base.cat "#{BASE_PATH}gpio#{gpio}/value")
+    end
+
+    #############################################################################
+    # Set a specific pin to the nominated value
+    #
+    # pin         : the pin to be set (will be translated to GPIO)
+    # value       : the value to be used
+    #
+    def value_set_pin(pin, value)
+
+      # Validate the pin
+      pin_ = ValidatePin.new pin
+      return pin_.error_message unless pin_.valid?
+
+      # Set the value after translating to gpio
+      value_set_gpio pin_.to_gpio, value
+    end
+
+    #############################################################################
+    # Set a specific gpio to the nominated value
+    #
+    # gpio        : the gpio to be set
+    # value       : the value to be used
+    #
+    def value_set_gpio(gpio, value)
+
+      # Validate the gpio
+      gpio_          = ValidateGpio.new gpio
+      return gpio_.error_message unless gpio_.valid?
+
+      # Validate the value
+      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"
+      return UdooNeoRest::Base.status_ok if result.empty?
+
+      # Check for a common error and provide some advice
+      if result =~ /not permitted/
+        return UdooNeoRest::Base.status_error('Operation not permitted error occurred. Has the gpio been set to output mode?')
+      end
+
+      # Otherwise just return the error
+      UdooNeoRest::Base.status_error result
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: udooneorest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rest API for interacting with UDOO Neo GPIOs, motion sensors and brick
+  sensors
+email: mark@sullivans.id.au
+executables:
+- udooneorest
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- bin/udooneorest
+- lib/udooneorest.rb
+- lib/udooneorest/accelerometer.rb
+- lib/udooneorest/barometer.rb
+- lib/udooneorest/direction.rb
+- lib/udooneorest/export.rb
+- lib/udooneorest/gyroscope.rb
+- lib/udooneorest/magnetometer.rb
+- lib/udooneorest/temperature.rb
+- lib/udooneorest/validators.rb
+- lib/udooneorest/value.rb
+homepage: http://rubygems.org/gems/udooneorest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rest API for interacting with UDOO Neo
+test_files: []