thomas-ghysbrecht-thermostat-exercise 0.1.2.pre.a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd2a9d561838ec347e9472ce9d99afe78a35eb1e
+  data.tar.gz: e0700576bdd5ac5d5517bf80da662684f01b669a
+SHA512:
+  metadata.gz: 57a6b7915f5f8622ae6fa79b82f78675daff5c0fac8b3a80344cd1e382b90d4087437affc966cbd6f42cf10c621a7709e62cd49427bc095d268954715a50c8e9
+  data.tar.gz: daacfb7593ebb0a02906a0d1a4c8ef86108be863fee0beb57756272b89d27d726b2591f7920f6110d8e19f4a6998c987bc0679d517b46d08d868d3c4de130f26

data/bin/thermostat

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/thermos.rb"
+require_relative "../lib/httpsvalue.rb"
+require_relative "../lib/logger.rb"
+require_relative "../lib/status.rb"
+require_relative "../lib/mqtttemp.rb"
+require_relative "../lib/parser.rb"
+require "OpenSSL"
+require 'json'
+require 'rubygems'
+
+parser_var = Parser.new
+options = parser_var.parse(ARGV)
+
+logger = ThermoLogger.new()
+status = Status.new()
+
+if(options.mqtt)
+    mqtttemp = Mqtttemp.new(options.mqtt)
+end
+
+nest = Thermos.new(options.target, options.range)
+
+#Get a termperature from the console arguments
+if(options.kelvin || options.celcius || options.fahrenheit)
+    nest.set_kelvin(options.kelvin) if options.kelvin
+    nest.set_celcius(options.celcius) if options.celcius
+    nest.set_fahrenheit(options.fahrenheit) if options.fahrenheit
+    status.get_status(nest)
+    logger.log_event(nest)
+end
+
+
+#Get a temperature from the internet
+if(options.httplink)
+    OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE #Bypass the SSL certificate problem, but gives a warning :(
+    httpsvalue = Httpsvalue.new
+    nest.set_celcius(httpsvalue.get_value(options.httplink).to_f)
+    status.get_status(nest)
+    logger.log_event(nest)
+end
+
+#Get a temperature from a Json file
+if(options.json)
+    nest.set_celcius(JSON.parse(File.read(options.json))["temperature"].to_f)
+    status.get_status(nest)
+    logger.log_event(nest)
+end
+
+#Get the temperature from MQTT
+if(options.subscribe)
+    mqtttemp.on_change do |temp|
+        nest.set_celcius(temp);
+        status.get_status(nest);
+        logger.log_event(nest);
+        mqtttemp.send_led_hex(nest.get_hex_leds, options.publish) if options.publish
+    end
+
+    mqtttemp.enable_thread(options.subscribe);
+
+    while(true)
+    end
+end

data/lib/httpsvalue.rb

@@ -0,0 +1,10 @@
+# The Httpsvalue returns a value on a webpage.
+#
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class Httpsvalue
+    require "open-uri"
+        # Get a value fromt this url
+        def get_value(url)
+            data = URI.parse(url).read
+        end
+end

data/lib/logger.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+# The ThermoLoger class logs the thermos object's status in a file.
+#
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class ThermoLogger
+
+    # Logs a message to a file
+    def log_message(message)
+        open('log.txt', 'a') do |f|
+          f.puts message
+        end
+    end
+
+    # Logs the thermos class to a file
+    def log_event(thermos)
+        current_time = DateTime.now
+        log_message("-------------------------------------------------------")
+        log_message(current_time.strftime "%d/%m/%Y %H:%M:%S")
+        log_message("Received temperature value: " + thermos.temperature.to_s)
+        log_message("Led value: " + thermos.get_hex_leds)
+        log_message("Heater is " + (thermos.relaisHeater ? "ON" : "OFF"))
+        log_message("Cooler is " + (thermos.relaisCooler ? "ON" : "OFF"))
+    end
+end

data/lib/mqtttemp.rb

@@ -0,0 +1,53 @@
+require 'mqtt'
+
+# Mqtt class that makes it possible to receive and send values via mqtt.
+#
+# You can attach a block of code to run when a value is received. Also you can
+# send the led hex value via mqtt to a specified topic.
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class Mqtttemp
+
+  # Set up the class with the brokere server address
+  def initialize(server)
+      @server = server;
+  end
+
+  # Attachach a codeblock that will be executed when a value is received
+  def on_change &block
+    @on_change_block = block
+  end
+
+  # Enable a thread that executes the on_change block when something is
+  # received on the topic given via the argument.
+  def enable_thread(mqtt_topic)
+    Thread.new do
+        MQTT::Client.connect(@server) do |c|
+          c.get(mqtt_topic) do |topic,message|
+            if(isValidJson(message))
+                @on_change_block.call(JSON.parse(message)["temperature"]) unless @on_change_block.nil?
+            end
+          end
+        end
+      end
+    end
+
+
+  def isValidJson(json)
+      JSON.parse(json)
+      return true
+    rescue JSON::ParserError => e
+      return false
+  end
+
+  # Send a hex value via MQTT to a topic.
+  # Argumens:
+  # hex (string) : The hex value that needs to be sent in format "FFAA33".
+  # topic (string) : The topic where to send the hex value to.
+  def send_led_hex(hex, topic)
+      MQTT::Client.connect(@server) do |c|
+           data = '{"color":"'+ hex +'"}'
+          c.publish(topic, data)
+      end
+  end
+
+end

data/lib/parser.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+
+Options = Struct.new(:kelvin, :celcius, :target, :fahrenheit, :range, :httplink, :mqtt, :json, :subscribe, :publish )
+
+# Parser class using optparse, this makes it possible to easly use this
+# app as an CLI app. 
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class Parser
+  def parse(options)
+    args = Options.new()
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: app.rb [options]"
+
+      opts.on("-K", "--Kelvin=TEMP",Float, "Temperature in Kelvin") do |arg|
+        args.kelvin = arg
+      end
+
+      opts.on("-C", "--Celcius=TEMP",Float, "Temperature in Celcius") do |arg|
+        args.celcius = arg
+      end
+
+      opts.on("-F", "--Fahrenheit=TEMP",Float, "Temperature in Fahrenheit") do |arg|
+        args.fahrenheit = arg
+      end
+
+      opts.on("-t", "--target=TEMP",Float, "Target temperature") do |arg|
+        args.target = arg
+      end
+
+      opts.on("-r", "--range=TEMP",Float, "Range for temperature") do |arg|
+        args.range = arg
+      end
+
+      opts.on("-H", "--httpget=LINK", "Get the temperature from the link") do |arg|
+        args.httplink = arg
+      end
+
+      opts.on("-m", "--mqtt=LINK", "Set the mqtt broker link") do |arg|
+        args.mqtt = arg
+      end
+
+      opts.on("-s", "--subscribe=NAME", "Subscribe to MQTT channel (broker link mandatory)") do |arg|
+        args.subscribe = arg
+      end
+
+      opts.on("-p", "--publish=NAME", "Publish to MQTT channel (broker link mandatory)") do |arg|
+        args.publish = arg
+      end
+
+      opts.on("-j", "--json=FILENAME", "Use a JSON file for the temperature") do |arg|
+        args.json = arg
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+
+    raise OptionParser::MissingArgument if args.range.nil?
+    raise OptionParser::MissingArgument if args.target.nil?
+
+    return args
+  end
+end

data/lib/status.rb

@@ -0,0 +1,25 @@
+# Status class that prints out the themos object's status
+#
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class Status
+    # Prints out the current status in the console
+    def get_status(nest)
+        puts "----------------------------------------------------------------------------------------"
+        puts "+-------------------------+"
+        puts "|       Led Status        |"
+        puts "+-------------------------+"
+        puts  "Red led:  #{nest.red.round(0)}"
+        puts  "Green led: #{nest.green.round(0)}"
+        puts  "Blue led: #{nest.blue.round(0)}"
+        puts  "Hex value: " + nest.get_hex_leds
+        puts "+-------------------------+"
+        puts "|     Relais Status       |"
+        puts "+-------------------------+"
+        puts  "Cooler:   " + (nest.relaisCooler ? "ON" : "OFF")
+        puts  "Heater:   " + (nest.relaisHeater ? "ON" : "OFF")
+        puts "+-------------------------+"
+        puts "|   Temperature Status    |"
+        puts "+-------------------------+"
+        puts  "Temperature: #{nest.temperature.round(1)}"
+    end
+end

data/lib/thermos.rb

@@ -0,0 +1,90 @@
+# Temperature class with multiple temperature compatibility
+#
+# The Temperature class stores a temperature. And decides the led color and relais.
+# @author Thomas Ghysbrecht <ghysbrecht@hotmail.com>
+class Thermos
+
+   attr_accessor :target
+   attr_accessor :range
+
+   attr_reader :red
+   attr_reader :green
+   attr_reader :blue
+   attr_reader :relaisCooler
+   attr_reader :relaisHeater
+   attr_reader :temperature
+
+   # Initializes the class with a target and range
+   # Arguments:
+   # - target (float) : The target temperature
+   # - range (float) : What temperatures are acceptable around the target
+   def initialize(target, range)
+       @target = target
+       @range = range
+       reset_leds
+       @relaisCooler = false;
+       @relaisHeater = false;
+   end
+
+   # Sets the temperature with a Celcius value.
+   # This method also reset and sets the leds.
+   def set_celcius (temperature)
+       @temperature = temperature
+       reset_leds
+       set_leds
+   end
+
+   # Sets the temperature with a Kelvin value
+   # This method also reset and sets the leds.
+   def set_kelvin (temperature)
+       @temperature = temperature - 273.15
+       reset_leds
+       set_leds
+   end
+
+   # Sets the temperature with a Fahrenheit value
+   # This method also reset and sets the leds.
+   def set_fahrenheit (temperature)
+       @temperature = (temperature - 32)/1.8
+       reset_leds
+       set_leds
+   end
+
+   def reset_leds
+       @red = 0.0
+       @green = 0.0
+       @blue = 0.0
+   end
+
+
+   def set_leds
+       if(@temperature < (@target - @range))
+           multiplier = ( (@target - @temperature) / (5 * @range)) #5 times the range from the target is very blue
+           multiplier > 1 ? multiplier = 1 : multiplier = multiplier
+           @blue = 255*multiplier
+
+           @relaisHeater = true;
+           @relaisCooler = false;
+
+       elsif(@temperature > (@target + @range))
+           multiplier = ( (@temperature - @target) / (5 * @range)) #5 times the range from the target is very red
+           multiplier > 1 ? multiplier = 1 : multiplier = multiplier
+           @red = 255*multiplier
+
+           @relaisHeater = false;
+           @relaisCooler = true;
+       else
+           multiplier = ((@temperature - @target).abs  / @range ) #0 time the range from the target is very green
+           @green = 255*(1-multiplier)
+
+           @relaisHeater = false;
+           @relaisCooler = false;
+       end
+   end
+
+   # Return the led status in hex format -> FF88AA
+   def get_hex_leds
+       "%02x%02x%02x" % [@red,@green,@blue]
+   end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: thomas-ghysbrecht-thermostat-exercise
+version: !ruby/object:Gem::Version
+  version: 0.1.2.pre.a
+platform: ruby
+authors:
+- Thomas Ghysbrecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies: []
+description: A thermostat simulator in ruby
+email: ghysbrecht@hotmail.com
+executables:
+- thermostat
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/thermostat
+- lib/httpsvalue.rb
+- lib/logger.rb
+- lib/mqtttemp.rb
+- lib/parser.rb
+- lib/status.rb
+- lib/thermos.rb
+homepage: https://github.com/thomieboy/ruby-thermos
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby thermostat
+test_files: []