huebot 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7febcd2a42112b4c3636581d9419a58c490a1157637e143fd46e6e7d94aefba5
-  data.tar.gz: d4a9ab3178d381786595f14a14899e55af7789b4650cfa2da1928b83b5fe2135
+  metadata.gz: 643b636258939c0eb021d13d9369d845be85a5854ca1f6c38fa66c6556551c68
+  data.tar.gz: e5e1e74fded7ed9d456f8a7ce0c65f8f787a08187eb019413bddaff7bddaca74
 SHA512:
-  metadata.gz: 15150d4cd9652f7d5e2518bd714de8155f1b574054360f61c0ac383c30f6fe81e3421f0bf64f0da43f090dabd2677b71609ae0a1e4f3741524adcdd631bd1116
-  data.tar.gz: 548d5adc4af710d2b1c9719e54fad7aa5fe5ba18749845089d0cb66fb59b4fd5e8279acc4214e961757c9956bad0b79ed8dacf4e531e3f54097322ce44a6b4bb
+  metadata.gz: '084232072462be01ec7867aadb43df7b476e4c0b6fe0fcc33b1d10cd23f568b8474d83ed450f0487123ce874c33a729d84bfa9e4cc683a59958e3b5fe7bd64e0'
+  data.tar.gz: 99c1ba63f4ff21161017fe42180ae76c5ee27721e32e7663eb5d09906953ef88886dd7e003f40e783e0ede9e3e5e123fab5635b5e0413085bf5882ebcb386bb8

data/README.md

@@ -34,13 +34,15 @@ serial:
               state:
                 bri: 150
                 time: 10 # 10 second transition
-              pause: 2   # 2 second pause before the next step
+              pause:
+                after: 2   # 2 second pause before the next step
 
           - transition:
               state:
                 bri: 254
                 time: 10 # 10 second transition
-              pause: 2   # 2 second pause before the next step
+              pause:
+                after: 2   # 2 second pause before the next step
 
     - transition:
         state:
@@ -78,12 +80,14 @@ serial:
                     state:
                       bri: 254
                       time: 10 # transition over 10 seconds
-                    pause: 5   # pause an extra 5 sec after the transition
+                    pause:
+                      after: 5   # pause an extra 5 sec after the transition
                 - transition:
                     state:
                       bri: 25
                       time: 10
-                    pause: 5
+                    pause:
+                      after: 5
 
           # Parallel branch 2: Fade inputs #2 and #4 down and up
           - serial:
@@ -96,12 +100,14 @@ serial:
                     state:
                       bri: 25
                       time: 10
-                    pause: 5
+                    pause:
+                      after: 5
                 - transition:
                     state:
                       bri: 254
                       time: 10
-                    pause: 5
+                    pause:
+                      after: 5
 ```
 
 [See the Wiki](https://github.com/jhollinger/huebot/wiki) for more documentation and examples.

data/lib/huebot/bot.rb

@@ -18,47 +18,49 @@ module Huebot
     private
 
     def exec(node)
-      i = node.instruction
-      case i
+      case node.instruction
       when Program::AST::Transition
-        transition i.state, i.devices, i.sleep
+        transition node.instruction
       when Program::AST::SerialControl
-        serial node.children, i.loop, i.sleep
+        serial node.children, node.instruction
       when Program::AST::ParallelControl
-        parallel node.children, i.loop, i.sleep
+        parallel node.children, node.instruction
       else
-        raise Error, "Unexpected instruction '#{i.class.name}'"
+        raise Error, "Unexpected instruction '#{node.instruction.class.name}'"
       end
     end
 
-    def transition(state, device_refs, sleep_time = nil)
-      time = (state["transitiontime"] || 4).to_f / 10
-      devices = map_devices device_refs
+    def transition(i)
+      time = (i.state["transitiontime"] || 4).to_f / 10
+      devices = map_devices i.devices
       @logger.log :transition, {devices: devices.map(&:name)}
 
+      wait i.pause.pre if i.pause&.pre
       devices.map { |device|
         Thread.new {
           # TODO error handling
-          _res = device.set_state state
-          @logger.log :set_state, {device: device.name, state: state, result: nil}
-          wait time
+          _res = device.set_state i.state
+          @logger.log :set_state, {device: device.name, state: i.state, result: nil}
+          wait time if i.wait
         }
       }.map(&:join)
-      wait sleep_time if sleep_time
+      wait i.pause.post if i.pause&.post
     end
 
-    def serial(nodes, lp, sleep_time = nil)
-      control_loop(lp) { |loop_type|
+    def serial(nodes, i)
+      wait i.pause.pre if i.pause&.pre
+      control_loop(i.loop) { |loop_type|
         @logger.log :serial, {loop: loop_type}
         nodes.each { |node|
           exec node
         }
       }
-      wait sleep_time if sleep_time
+      wait i.pause.post if i.pause&.post
     end
 
-    def parallel(nodes, lp, sleep_time = nil)
-      control_loop(lp) { |loop_type|
+    def parallel(nodes, i)
+      wait i.pause.pre if i.pause&.pre
+      control_loop(i.loop) { |loop_type|
         @logger.log :parallel, {loop: loop_type}
         nodes.map { |node|
           Thread.new {
@@ -67,33 +69,37 @@ module Huebot
           }
         }.map(&:join)
       }
-      wait sleep_time if sleep_time
+      wait i.pause.post if i.pause&.post
     end
 
     def control_loop(lp)
       case lp
       when Program::AST::InfiniteLoop
         loop {
+          wait lp.pause.pre if lp.pause&.pre
           yield :infinite
-          wait lp.pause if lp.pause
+          wait lp.pause.post if lp.pause&.post
         }
       when Program::AST::CountedLoop
         lp.n.times {
+          wait lp.pause.pre if lp.pause&.pre
           yield :counted
-          wait lp.pause if lp.pause
+          wait lp.pause.post if lp.pause&.post
         }
       when Program::AST::DeadlineLoop
         until Time.now >= lp.stop_time
+          wait lp.pause.pre if lp.pause&.pre
           yield :deadline
-          wait lp.pause if lp.pause
+          wait lp.pause.post if lp.pause&.post
         end
       when Program::AST::TimerLoop
         sec = ((lp.hours * 60) + lp.minutes) * 60
         time = 0
         until time >= sec
           start = Time.now
+          wait lp.pause.pre if lp.pause&.pre
           yield :timer
-          wait lp.pause if lp.pause
+          wait lp.pause.post if lp.pause&.post
           time += (Time.now - start).round
         end
       else

data/lib/huebot/cli/helpers.rb

@@ -5,6 +5,8 @@ require 'json'
 module Huebot
   module CLI
     module Helpers
+      DEFAULT_API_VERSION = 1.1
+
       #
       # Returns the command given to huebot.
       #
@@ -70,7 +72,7 @@ module Huebot
               opts.stderr.puts "Unknown file extension '#{ext}'. Expected .yaml, .yml, or .json"
               return []
             end
-          version = (src.delete("version") || 1.0).to_f
+          version = (src.delete("version") || DEFAULT_API_VERSION).to_f
           Program::Src.new(src, path, version)
         }
 
@@ -80,7 +82,7 @@ module Huebot
           src = raw[0] == "{" ? JSON.load(raw) : YAML.safe_load(raw)
 
           opts.stdout.puts "Executing..." if opts.read_stdin
-          version = (src.delete("version") || 1.0).to_f
+          version = (src.delete("version") || DEFAULT_API_VERSION).to_f
           sources << Program::Src.new(src, "STDIN", version)
         end
         sources

data/lib/huebot/compiler/api_v1.rb

@@ -51,40 +51,56 @@ module Huebot
       end
 
       def build_transition(t, errors, warnings, inherited_devices = nil)
+        if t.nil?
+          errors << "'transition' may not be blank"
+          t = {}
+        end
+
         state = build_state(t, errors, warnings)
         devices = build_devices(t, errors, warnings, inherited_devices)
-        slp = build_sleep(t, errors, warnings)
+        pause = build_pause(t, errors, warnings)
+        wait = @api_version >= 1.1 ? build_wait(t, errors, warnings) : true
 
         errors << "'transition' requires devices" if devices.empty?
         errors << "Unknown keys in 'transition': #{t.keys.join ", "}" if t.keys.any?
 
-        instruction = Program::AST::Transition.new(state, devices, slp)
+        instruction = Program::AST::Transition.new(state, devices, wait, pause)
         return instruction, []
       end
 
       def build_serial(t, errors, warnings, inherited_devices = nil)
+        if t.nil?
+          errors << "'serial' may not be blank"
+          t = {}
+        end
+
         lp = build_loop(t, errors, warnings)
-        slp = build_sleep(t, errors, warnings)
+        pause = build_pause(t, errors, warnings)
         devices = build_devices(t, errors, warnings, inherited_devices)
         children = build_steps(t, errors, warnings, devices)
 
         errors << "'serial' requires steps" if children.empty?
         errors << "Unknown keys in 'serial': #{t.keys.join ", "}" if t.keys.any?
 
-        instruction = Program::AST::SerialControl.new(lp, slp)
+        instruction = Program::AST::SerialControl.new(lp, pause)
         return instruction, children
       end
 
       def build_parallel(t, errors, warnings, inherited_devices = nil)
+        if t.nil?
+          errors << "'parallel' may not be blank"
+          t = {}
+        end
+
         lp = build_loop(t, errors, warnings)
-        slp = build_sleep(t, errors, warnings)
+        pause = build_pause(t, errors, warnings)
         devices = build_devices(t, errors, warnings, inherited_devices)
         children = build_steps(t, errors, warnings, devices)
 
         errors << "'parallel' requires steps" if children.empty?
         errors << "Unknown keys in 'parallel': #{t.keys.join ", "}" if t.keys.any?
 
-        instruction = Program::AST::ParallelControl.new(lp, slp)
+        instruction = Program::AST::ParallelControl.new(lp, pause)
         return instruction, children
       end
 
@@ -167,9 +183,7 @@ module Huebot
         loop_val = t.delete "loop"
         case loop_val
         when Hash
-          pause = loop_val.delete "pause"
-          errors << "'loop.pause' must be an integer. Found '#{pause.class.name}'" if pause and !pause.is_a? Integer
-
+          pause = build_pause(loop_val, errors, warnings)
           lp =
             case loop_val.keys
             when INFINITE_KEYS
@@ -216,11 +230,19 @@ module Huebot
         Program::AST::DeadlineLoop.new(stop_time)
       end
 
-      def build_sleep(t, errors, warnings)
-        sleep_val = t.delete "pause"
-        case sleep_val
+      def build_pause(t, errors, warnings)
+        case @api_version
+        when 1.0 then build_pause_1_0(t, errors, warnings)
+        when 1.1 then build_pause_1_1(t, errors, warnings)
+        else raise Error, "Unknown api version '#{@api_version}'"
+        end
+      end
+
+      def build_pause_1_0(t, errors, warnings)
+        pause_val = t.delete "pause"
+        case pause_val
         when Integer, Float
-          sleep_val
+          Program::AST::Pause.new(nil, pause_val)
         when nil
           nil
         else
@@ -229,6 +251,39 @@ module Huebot
         end
       end
 
+      def build_pause_1_1(t, errors, warnings)
+        pause_val = t.delete "pause"
+        case pause_val
+        when Integer, Float
+          Program::AST::Pause.new(nil, pause_val)
+        when Hash
+          pre = pause_val.delete "before"
+          post = pause_val.delete "after"
+          errors << "'pause.before' must be an integer or float" unless pre.nil? or pre.is_a? Integer or pre.is_a? Float
+          errors << "'pause.after' must be an integer or float" unless post.nil? or post.is_a? Integer or post.is_a? Float
+          errors << "Unknown keys in 'pause': #{pause_val.keys.join ", "}" if pause_val.keys.any?
+          Program::AST::Pause.new(pre, post)
+        when nil
+          nil
+        else
+          errors << "'pause' must be an integer or float"
+          nil
+        end
+      end
+
+      def build_wait(t, errors, warnings)
+        wait = t.delete "wait"
+        case wait
+        when true, false
+          wait
+        when nil
+          true
+        else
+          errors << "'transition.wait' must be true or false"
+          true
+        end
+      end
+
       def build_devices(t, errors, warnings, inherited_devices = nil)
         devices_ref = t.delete("devices") || {}
         return inherited_devices if devices_ref.empty? and inherited_devices

data/lib/huebot/compiler/compiler.rb

@@ -13,7 +13,7 @@ module Huebot
     def self.build(src)
       compiler_class =
         case src.api_version
-        when 1.0 then ApiV1
+        when 1.0, 1.1 then ApiV1
         else raise Error, "Unknown API version '#{src.api_version}'"
         end
       compiler = compiler_class.new(src.api_version)

data/lib/huebot/program.rb

@@ -16,15 +16,16 @@ module Huebot
     module AST
       Node = Struct.new(:instruction, :children, :errors, :warnings)
 
-      Transition = Struct.new(:state, :devices, :sleep)
-      SerialControl = Struct.new(:loop, :sleep)
-      ParallelControl = Struct.new(:loop, :sleep)
+      Transition = Struct.new(:state, :devices, :wait, :pause)
+      SerialControl = Struct.new(:loop, :pause)
+      ParallelControl = Struct.new(:loop, :pause)
 
       InfiniteLoop = Struct.new(:pause)
       CountedLoop = Struct.new(:n, :pause)
       TimerLoop = Struct.new(:hours, :minutes, :pause)
       DeadlineLoop = Struct.new(:stop_time, :pause)
 
+      Pause = Struct.new(:pre, :post)
       DeviceRef = Struct.new(:ref)
       Light = Struct.new(:name)
       Group = Struct.new(:name)

data/lib/huebot/version.rb

@@ -1,4 +1,4 @@
 module Huebot
   # Gem version
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huebot
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2023-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest