thermostat_robin_spruytte 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaa870098c27235830f1cd4f93605d35f4f2509433be676415d4d6a42239f84f
-  data.tar.gz: 86a4bddc6b031cff43a8b1823fd7bce92554f2d044912e9f7b3ce7e0f508575c
+  metadata.gz: 24454b9eca142e3f4f9ec8838dc804fe46fcbd04f4a05d9ef9aed1fd346a4edf
+  data.tar.gz: e7fee0d9ae1ffc2f356805a3296550703c11d8c730a1e68ef7235325e824270a
 SHA512:
-  metadata.gz: 5b1f7e36bf662a90ee7e73b55cea0eaf855c50ed45a0da9f25d29b5f2eecb073452c052a876fd2c972a955d6eb113f2c26fe4f0a4a9f1e267d831c0e73e7d31a
-  data.tar.gz: 35efac5ae3739b48d7fc3bfef0900c0fb7fc2105f2135c8997da24eaeda18973f94e7c276a6ef5c4b4f1936fa38c564efc0cc04282513657d71d4d7e8a603c44
+  metadata.gz: 8e9846ffb6636a50b06d6cd807259d1eccdc2a4d7cf1246299a096f25d0a71c188864295766a30d6de707f966a15d5fbf1c6b909f9ee4cf753be6ce88ad649cd
+  data.tar.gz: aa0c241aaf17bd96c25231ad907dbb4b22b056abae066c8c514b53d470dc65d81a540cc595d32084e561f8e332c78b0d3cd3f139c1aa1f72bf538f50d4e05b7f

data/lib/app.rb

@@ -0,0 +1,99 @@
+# The App class, contains the logic to ceep the room temperature 
+# within a desired value
+class App
+  attr_reader :wanted_temperature, :thermostat, :range, :update_speed
+  # Initialises the App class
+  # @param wanted_temperature [wanted_temperature] the desired room temperature
+  # @param range [range] the range in wich the room temperature must stay from
+  # the desired temperature
+  # @param thermostat [thermostat] an instance from the class Thermostat
+  # @param update_speed [update_speed] the speed at wich the app will run
+  def initialize(args)
+    @wanted_temperature = args[:wanted_temperature]
+    @range = get_range(input_range: args[:range])
+    @thermostat = args[:thermostat]
+    @update_speed = args[:update_speed] || 1
+  end
+
+  # Starts the application
+  def run
+    loop do
+      print("\ntermostaat temperatuur: #{thermostat_temperature}")
+      correct_temperature
+      sleep(update_speed)
+    end
+  end
+
+  # gets the range value used in calculations
+  # @param input_range [input_range] the range in wich the room temperature must
+  # stay from the desired temperature
+  # @return [number] the actual range
+  def get_range(args)
+    args[:input_range] / 2.0
+  end
+
+  # says the thermostat if it must heat up or cool down to reach the
+  # desired temperature
+  # @return [Struct] contains what actions the thermostat took
+  def correct_temperature
+    cooling = cool_thermostat(temperature: thermostat_temperature)
+    heating = heat_thermostat(temperature: thermostat_temperature)
+    output = Struct.new(:cooling, :heating)
+    output.new(cooling, heating)
+  end
+
+  # Checks if the thermostat must cool down to reach the desired
+  # temperature
+  # @param temperature [temperature] the current room temperature
+  # @return [Boolean] true if the thermostat had to cool down if not, false
+  def cool_thermostat(args)
+    if temperature_out_of_range(temperature: args[:temperature]) &&
+       temperature_to_high(temperature: args[:temperature])
+      thermostat.cooling(value: range)
+      true
+    else
+      false
+    end
+  end
+
+  # Checks if the thermostat must heat up to reach the desired
+  # temperature
+  # @param temperature [temperature] the current room temperature
+  # @return [Boolean] true if the thermostat had to warm up if not, false
+  def heat_thermostat(args)
+    if temperature_out_of_range(temperature: args[:temperature]) &&
+       temperature_to_low(temperature: args[:temperature])
+      thermostat.heating(value: range)
+      true
+    else
+      false
+    end
+  end
+
+  # Checks if the temperature is out of range
+  # @param temperature [temperature] the current room temperature
+  # @return [Boolean] true if the thermostat is out of range else, false
+  def temperature_out_of_range(args)
+    (args[:temperature] - wanted_temperature).abs > range
+  end
+
+  # Checks if the temperature is to low
+  # @param temperature [temperature] the current room temperature
+  # @return [Boolean] true if the temperature is to low else, false
+  def temperature_to_low(args)
+    args[:temperature] < wanted_temperature
+  end
+
+  # Checks if the temperature is to high
+  # @param temperature [temperature] the current room temperature
+  # @return [Boolean] true if the temperature is to high else, false
+  def temperature_to_high(args)
+    args[:temperature] > wanted_temperature
+  end
+
+  # gets the current temperature of the thermostat
+  # @return [number] the current thermostat temperature
+  def thermostat_temperature
+    thermostat.temperature
+  end
+end

data/lib/json_thermostat.rb

@@ -0,0 +1,53 @@
+require 'thermostat.rb'
+require 'unitconverter.rb'
+require 'app.rb'
+
+# Takes in JSON strings from external sources like sencors
+# and passes the information to the application
+class JSONThermostat
+  attr_accessor :thermostat, :app, :settings, :converter
+
+  # Initialises the JSONThermostat class
+  # @param json [String] a json string containing the thermostat settings, of
+  # the form {temperature: 293.15, range: 1.0, unit: "kelvin"} unit is
+  # optional and will default to celsius
+  def initialize(settings_json)
+    @settings = get_parsed_json(json: settings_json)
+    @thermostat = Thermostat.new
+    @converter = UnitConverter.new(desired_unit: settings['unit'])
+    @app = App.new(
+      wanted_temperature: settings['temperature'],
+      range: settings['range'],
+      thermostat: thermostat
+    )
+  end
+
+  # takes in a JSON string from outside sources and updates the application
+  # @param sensordata_json [sensordata_json] the JSON string of the form:
+  # {temperature: 293.15, unit: "kelvin"} with the unit defaulting to
+  # celsius if not specified
+  # @return [JSON] the resulting webpage of the form
+  # {cooling: Boolean, heating: Boolean}
+  def update(sensordata_json)
+    json = get_parsed_json(json: sensordata_json)
+    update_temperature(temperature: json['temperature'], unit: json['unit'])
+    output = app.correct_temperature
+    JSON.generate(cooling: output.cooling, heating: output.heating)
+  end
+
+  # updates the temperature of the thermostat
+  # @param temperature [temperature] the request object
+  def update_temperature(args)
+    thermostat.temperature = converter.convert(
+      value: args[:temperature],
+      input_unit: args[:unit]
+    )
+  end
+
+  # Parses a JSON string to a JSON object
+  # @param json [json] the json string
+  # @return [JSON] the resulting JSON object
+  def get_parsed_json(args)
+    JSON.parse(args[:json])
+  end
+end

data/lib/unitconverter.rb

@@ -0,0 +1,87 @@
+# Converts temperatures expressed in different units to the unit that the
+# application works with
+class UnitConverter
+  attr_reader :desired_unit
+
+  # Initialises the UnitConverter class
+  # @param desired_unit [desired_unit] The desired unit of the application
+  def initialize(args)
+    @desired_unit = get_unit(unit: args[:desired_unit] || nil)
+  end
+
+  # returns the unit in wich the external sensor works
+  # @param unit [unit] the unit of the sensor, defaults to celsius
+  # @return [String] the unit in wich the sensor works
+  def get_unit(args)
+    args[:unit] || 'celsius'
+  end
+
+  # Checks if the input temperature actually needs to be converted
+  # @param input_unit [input_unit] the unit of the sensor
+  # @return [Boolean] true if the input temperature needs to be converted
+  def needs_conversion(args)
+    desired_unit != args[:input_unit]
+  end
+
+  # Converts the input temperature to the desired unit
+  # @param value [value] the input temperature
+  # @param input_unit [input_unit] the unit of the sensor defaults to celsius
+  # @return [Number] the converted temperature
+  def convert(args)
+    output = args[:value]
+    input_unit = get_unit(unit: args[:input_unit] || nil)
+    if needs_conversion(input_unit: input_unit)
+      output = send conversion_method(input_unit: input_unit), value: output
+    end
+    output
+  end
+
+  # gets the name of the right conversion method
+  # @param input_unit [input_unit] the sensor unit
+  # @return [String] the name of the needed conversion method
+  def conversion_method(args)
+    args[:input_unit] + '_to_' + desired_unit
+  end
+
+  # converts a temperature in celcius to kelvin
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def celsius_to_kelvin(args)
+    args[:value] + 273.15
+  end
+
+  # converts a temperature in celcius to fahrenheit
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def celsius_to_fahrenheit(args)
+    (args[:value] * 1.8) + 32
+  end
+
+  # converts a temperature in fahrenheit to celsius
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def fahrenheit_to_celsius(args)
+    (args[:value] - 32) / 1.8
+  end
+
+  # converts a temperature in fahrenheit to kelvin
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def fahrenheit_to_kelvin(args)
+    celsiusToKelvin(fahrenheitToCelsius(value: args[:value]))
+  end
+
+  # converts a temperature in kelvin to celsius
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def kelvin_to_celsius(args)
+    args[:value] - 273.15
+  end
+
+  # converts a temperature in kelvin to fahrenheit
+  # @param value [value] the input temperature
+  # @return [Number] the converted temperature
+  def kelvin_to_fahrenheit(args)
+    (kelvinToCelsius(value: args[:value]) * 1.8) + 32
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thermostat_robin_spruytte
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Robin Spruytte
@@ -18,7 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/thermostat
+- lib/app.rb
+- lib/json_thermostat.rb
 - lib/thermostat.rb
+- lib/unitconverter.rb
 homepage: http://rubygems.org/gems/thermostat_robin_spruytte
 licenses:
 - MIT