sparkle_motion 0.1.0

data/bin/sm-watch-memory

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+while [ 1 ]; do
+  ps auxwww |
+    grep rub[y] |
+    grep sm-simulate |
+    awk '{ print $6 }' | perl -pse 's/\n/, /g' | perl -pse 's/, $/\n/'
+  sleep 1
+done

data/bin/sparkle-motion

@@ -0,0 +1,48 @@
+#!/bin/bash
+###############################################################################
+# Visual Effects
+###############################################################################
+# Whether to use background sweep thread for saw-tooth pattern on hue:
+export USE_SWEEP=1
+# Whether to actually run main lighting threads:
+export USE_LIGHTS=1
+# Whether or not to run the simulation graph:
+export USE_GRAPH=1
+# Whether or not to use Novation LaunchPad for controls:
+export USE_INPUT=1
+
+
+###############################################################################
+# Debugging
+###############################################################################
+# Run for a fixed number of iterations, or until we're killed (0):
+export ITERATIONS=0
+
+# Forcibly disable Ruby GC:
+export SKIP_GC=0
+
+# Logging verbosity.  Valid values: DEBUG, INFO, WARN, ERROR.  Default is INFO.
+export SPARKLEMOTION_LOGLEVEL=INFO
+
+# Whether to run a profiler:
+export PROFILE_RUN= # ruby-prof|memory_profiler
+
+# If using ruby-prof, what mode to run it in:
+export RUBY_PROF_MODE=allocations  # ALLOCATIONS, CPU_TIME, GC_RUNS, GC_TIME, MEMORY, PROCESS_TIME, WALL_TIME
+
+# Dump various PNGs showing the results of given nodes in the DAG over time.
+# This is VERY VERY memory intensize!  Don't try to use it for a long run!
+# Current nodes: perlin, stretched, shifted_0, shifted_1, shifted_2, shifted_3, spotlit, output
+# ... however you probably don't care about shifted_0..shifted_2.
+export DEBUG_NODES= #perlin,stretched,shifted_3,spotlit,output
+
+
+###############################################################################
+echo "Beginning simulation.  Press ctrl-c to end."
+touch /tmp/sparkle-motion.state
+EXIT_FLAG=127
+while [ $EXIT_FLAG != 0 ]; do
+  ./bin/sm-simulate
+  EXIT_FLAG=$?
+  echo "Process terminated with exit code: $EXIT_FLAG"
+done

data/config.yml

@@ -0,0 +1,201 @@
+---
+common_username: &common_username "1234567890"
+# Determine HTTP request concurrency for updating lights.  Per-bridge.
+max_connects: 3
+bridges:
+  "Bridge-01":
+    ip: "192.168.2.10"
+    username: *common_username
+    debug_hue: 0
+  "Bridge-02":
+    ip: "192.168.2.6"
+    username: *common_username
+    debug_hue: 25000
+  "Bridge-03":
+    ip: "192.168.2.7"
+    username: *common_username
+    debug_hue: 45000
+  "Bridge-04":
+    ip: "192.168.2.9"
+    username: *common_username
+    debug_hue: 12000
+simulation:
+  # TODO: Have day/night configurations and a way to LERP between them.
+  #
+  # TODO: Tool for testing bulb positioning.
+  #
+  # TODO: Use mid-point/range notation for intensity to make tweaking easier.
+  #
+  # TODO: Duck intensity when tweaking saturation.
+  #
+  # TODO: Finish simulation visualization tool.
+  #
+  # TODO: Re-parameterize sleep option, and maybe add a way to tweak it on the fly.
+  #
+  # TODO: Add outer-loop script, and use exit codes to differentiate between restart and terminate.
+  #
+  # TODO: Way to tweak output transition time on the fly?
+  #
+  # TODO: Separate color-sweeps per bridge.
+  #
+  # TODO: Way to tweak sweep transition time on the fly?
+  #
+  # TODO: Play with X multiplier for Perlin component to see if that makes the lighting more visually interesting.
+  #
+  # TODO: Group all writes to a bridge into a single thread.
+  #
+  # TODO: Either self-tune delays, or avoid sending refreshes to each light/group too fast?
+  output:
+    transition: 0.3
+  sweep:
+    # Don't set this transition much below 1.0!  ZigBee spec only allows 1
+    # group update/sec, but Hue Bridge/lights seem to be OK with about 1 every
+    # 0.75 sec...
+    #
+    # Negative values mean to use a transition time of 0 for the change, but
+    # wait the absolute value between steps.
+    transition: 1.5
+    # Ballpark estimation of Jen's palette:
+    values:
+    - 49500
+    - 49500
+    - 48000
+    - 49500
+    - 49500
+    - 51000
+  nodes:
+    # wave2:
+    #   speed: [0.1, 1.0]
+    perlin:
+      speed: [0.1, 4.0]
+    contrast:
+      # Function: LINEAR, CUBIC, QUINTIC -- don't bother using iterations > 1
+      # with LINEAR, as LINEAR is a no-op.
+      function:   cubic
+      iterations: 3
+  controls:
+    exit:
+      position: mixer
+      colors:
+        "color": dark_gray
+        "down":  white
+    intensity:
+      widget: SparkleMotion::LaunchPad::Widgets::VerticalSlider
+      positions:
+      - [0, 4]
+      - [1, 4]
+      - [2, 4]
+      - [3, 4]
+      size: 4
+      values:
+      # Mid-point, delta (was low/high):
+      - [0.350, 0.050] #[0.25, 0.45]
+      - [0.500, 0.050] #[0.40, 0.60]
+      - [0.675, 0.125] #[0.55, 0.80]
+      - [0.875, 0.125] #[0.75, 1.00]
+      colors:
+        "on":   0x22003F
+        "off":  0x05000A
+        "down": 0x27103F
+    saturation:
+      widget: SparkleMotion::LaunchPad::Widgets::VerticalSlider
+      transition: 0.3
+      positions:
+      - [4, 4]
+      - [5, 4]
+      - [6, 4]
+      - [7, 4]
+      size: 4
+      groups:
+      - ["Bridge-01", 0]
+      - ["Bridge-02", 0]
+      - ["Bridge-03", 0]
+      - ["Bridge-04", 0]
+      values:
+      - 102
+      - 152
+      - 203
+      - 254
+      colors:
+        "on":   0x1C103F
+        "off":  0x03030C
+        "down": 0x10103F
+    spotlighting:
+      x: 0
+      y: 0
+      mappings:
+      # NOTE: Mappings defines the width/height of the widget implicitly!
+      # NOTE: Values are indexes into main_lights array.
+      #
+      # Excluding outermost lights, and going top-down for left-most to
+      # right-most light across left then right strings:
+      #
+      # Bridge 3/4:
+      - [14, 15, 16, 17,   18, 19, 20, 21]
+      # Bridge 1/2:
+      - [ 2, 3,  4,  5,     6,  7,  8,  9]
+      colors:
+        "on":   0x272700
+        "off":  0x020200
+        "down": 0x3F3F10
+# Main Lights is the group for which the main simulation will be applied.
+# It can be any number of lights from any number of bridges but you'll need to
+# plan groups out for saturation controls.
+main_lights:
+# Strip 1:
+- ["Bridge-01", 37]
+- ["Bridge-01", 36]
+- ["Bridge-01", 38]
+- ["Bridge-01", 39]
+- ["Bridge-01", 40]
+- ["Bridge-01", 35]
+
+- ["Bridge-02", 12]
+- ["Bridge-02", 21]
+- ["Bridge-02", 20]
+- ["Bridge-02", 19]
+- ["Bridge-02", 15]
+- ["Bridge-02", 18]
+
+# Strip 2:
+- ["Bridge-03", 2]
+- ["Bridge-03", 3]
+- ["Bridge-03", 8]
+- ["Bridge-03", 10]
+- ["Bridge-03", 9]
+- ["Bridge-03", 6]
+
+- ["Bridge-04", 7]
+- ["Bridge-04", 11]
+- ["Bridge-04", 12]
+- ["Bridge-04", 1]
+- ["Bridge-04", 9]
+- ["Bridge-04", 8]
+# TODO: Come up with appropriate behaviors/extensions of behavior for dance
+# TODO: floor:
+# TODO: * Spotighting.
+# TODO: * Saturation.
+# TODO: * Intensity.
+#
+# Dance Lights is the group of lights above the dance floor, which will get
+# their own simulation, although updates will be interleaved with the main
+# lights per-bridge.  It should be a positional map affording spatial
+# coherence.
+#
+# For spotlighting/saturation/intensity purposes, it will be treated as one
+# group.
+dance_lights:
+- ["Bridge-01", 26]
+- ["Bridge-02", 11]
+- ["Bridge-03", 7]
+- ["Bridge-04", 5]
+accent_lights:
+- ["Bridge-01", 9]
+- ["Bridge-01", 10]
+- ["Bridge-01", 11]
+- ["Bridge-01", 12]
+- ["Bridge-01", 13]
+- ["Bridge-01", 33]
+- ["Bridge-01", 34]
+- ["Bridge-02", 7]
+- ["Bridge-02", 8]

data/data/dynamic/bridges.csv

@@ -0,0 +1,5 @@
+Bridge,MAC,"Zigbee Channel"
+Bridge-01,00:17:88:12:26:f3,25
+Bridge-02,00:17:88:10:5e:da,15
+Bridge-03,00:17:88:18:53:d0,11
+Bridge-04,00:17:88:1a:1d:5c,20

data/data/static/devices.csv

@@ -0,0 +1,7 @@
+Manufacturer,Type,"Model ID",Series
+Philips,"Color light",LLC011,"Hue Bloom"
+Philips,"Color light",LST001,"LightStrips"
+Philips,"Dimmable light",LWB004,"Hue Lux"
+Philips,"Extended color light",LCT001,"Hue Lamp"
+Philips,"Extended color light",LCT002,"Hue Downlight"
+Philips,"Extended color light",LLC020,"Hue Go"

data/lib/sparkle_motion.rb

@@ -0,0 +1,72 @@
+lib = File.expand_path("../", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# We shave 1/6th of a sec off launch time by not doing the following, but it
+# presumes the user is using RVM properly to isolate the gem env, and that
+# there are no git/path-based gems in the Gemfile:
+# require "rubygems"
+# require "bundler/setup"
+
+require "yaml"
+require "logger-better"
+
+# System for building interesting, dynamic lighting effects for the Philips Hue,
+# using the Novation Launchpad for control.
+module SparkleMotion
+  def self.logger; @logger; end
+
+  def self.init!(name)
+    @logger         = Logger::Better.new(STDOUT)
+    @logger.level   = (ENV["SPARKLEMOTION_LOGLEVEL"] || "info").downcase.to_sym
+    @logger.progname = name
+  end
+
+  # Load code for talking to Philips Hue lighting system.
+  def self.use_hue!(discovery: false, api: false)
+    if api
+      require "sparkle_motion/results"
+      require "sparkle_motion/lazy_request_config"
+    end
+
+    if discovery
+      require "sparkle_motion/hue/ssdp"
+    end
+  end
+
+  # Load code for graph-structured effect generation.
+  def self.use_graph!
+    # Base classes:
+    require "sparkle_motion/node"
+    require "sparkle_motion/nodes/generator"
+    require "sparkle_motion/nodes/transform"
+
+    # Simulation root nodes:
+    require "sparkle_motion/nodes/generators/const"
+    require "sparkle_motion/nodes/generators/perlin"
+    require "sparkle_motion/nodes/generators/wave2"
+
+    # Simulation transform nodes:
+    require "sparkle_motion/nodes/transforms/contrast"
+    require "sparkle_motion/nodes/transforms/range"
+    require "sparkle_motion/nodes/transforms/spotlight"
+  end
+
+  def self.use_widgets!
+    require "sparkle_motion/launch_pad/widget"
+    require "sparkle_motion/launch_pad/widgets/horizontal_slider"
+    require "sparkle_motion/launch_pad/widgets/vertical_slider"
+    require "sparkle_motion/launch_pad/widgets/radio_group"
+    require "sparkle_motion/launch_pad/widgets/button"
+  end
+
+  # Load code/widgets for Novation LaunchPad.
+  def self.use_launchpad!
+    require "launchpad"
+  end
+end
+
+require "sparkle_motion/version"
+require "sparkle_motion/utility"
+require "sparkle_motion/config"
+require "sparkle_motion/env"
+require "sparkle_motion/http"

data/lib/sparkle_motion/config.rb

@@ -0,0 +1,45 @@
+# TODO: Load this on-demand, not automatically!  Namespace it!  AUGH!
+require "sparkle_motion/vector2"
+require "sparkle_motion/launch_pad/color"
+
+def unpack_color(col)
+  if col.is_a?(String)
+    SparkleMotion::LaunchPad::Color.const_get(col.upcase).to_h
+  else
+    { r: ((col >> 16) & 0xFF),
+      g: ((col >> 8) & 0xFF),
+      b: (col & 0xFF) }
+  end
+end
+
+def unpack_colors_in_place!(cfg)
+  cfg.each do |key, val|
+    if val.is_a?(Array)
+      cfg[key] = val.map { |vv| unpack_color(vv) }
+    else
+      cfg[key] = unpack_color(val)
+    end
+  end
+end
+
+def unpack_vector_in_place!(cfg)
+  cfg.each do |key, val|
+    next unless val.is_a?(Array) && val.length == 2
+    cfg[key] = Vector2.new(x: val[0], y: val[1])
+  end
+end
+
+CONFIG = YAML.load(File.read("config.yml"))
+CONFIG["bridges"].map do |name, cfg|
+  cfg["name"] = name
+end
+
+CONFIG["simulation"]["controls"].values.each do |cfg|
+  next unless cfg && cfg["colors"]
+  unpack_colors_in_place!(cfg["colors"])
+end
+
+CONFIG["simulation"]["nodes"].values.each do |cfg|
+  next unless cfg
+  unpack_vector_in_place!(cfg)
+end

data/lib/sparkle_motion/env.rb

@@ -0,0 +1,14 @@
+# TODO: Namespacing/classes/etc!
+def env_int(name, allow_zero = false)
+  return nil unless ENV.key?(name)
+  tmp = ENV[name].to_i
+  tmp = nil if tmp == 0 && !allow_zero
+  tmp
+end
+
+def env_float(name)
+  return nil unless ENV.key?(name)
+  ENV[name].to_f
+end
+
+def env_bool(name); (env_int(name, true) || 1) != 0; end

data/lib/sparkle_motion/http.rb

@@ -0,0 +1,26 @@
+# TODO: Namespacing/classes/etc!
+require "curb"
+require "oj"
+
+# TODO: Try to figure out how to set Curl::CURLOPT_TCP_NODELAY => true
+# TODO: Disable Curl from sending keepalives by trying HTTP/1.0.
+MULTI_OPTIONS = { pipeline:     false,
+                  max_connects: (CONFIG["max_connects"] || 3) }
+EASY_OPTIONS = { "timeout" =>         5,
+                 "connect_timeout" => 5,
+                 "follow_location" => false,
+                 "max_redirects" =>   0 } # ,
+                 # version:          Curl::HTTP_1_0 }
+#   easy.header_str.grep(/keep-alive/)
+# Force keepalive off to see if that makes any difference...
+# TODO: Use this: `easy.headers["Expect"] = ''` to remove a default header we don't care about!
+
+def hue_server(config); "http://#{config['ip']}"; end
+def hue_base(config); "#{hue_server(config)}/api/#{config['username']}"; end
+def hue_light_endpoint(config, light_id); "#{hue_base(config)}/lights/#{light_id}/state"; end
+def hue_group_endpoint(config, group); "#{hue_base(config)}/groups/#{group}/action"; end
+
+def with_transition_time(data, transition)
+  data["transitiontime"] = (transition * 10.0).round(0)
+  data
+end

data/lib/sparkle_motion/hue/ssdp.rb

@@ -0,0 +1,39 @@
+require "frisky/ssdp"
+Frisky.logging_enabled = false # Frisky is super verbose
+
+module SparkleMotion
+  module Hue
+    # Helpers for SSDP discovery of bridges.
+    class SSDP
+      def scan
+        raw = Frisky::SSDP
+              .search("IpBridge")
+              .select { |resp| ssdp_response?(resp) }
+              .map { |resp| ssdp_extract(resp) }
+              .select { |resp| resp["name"] == "upnp:rootdevice" }
+        Hash[raw.map { |resp| [resp["id"], resp["ipaddress"]] }]
+      end
+
+      # Ensure we're *only* getting responses from a Philips Hue bridge.  The
+      # Hue Bridge tends to be obnoxious and announce itself on *any* SSDP
+      # SSDP request, so we assume that we may encounter other obnoxious gear
+      # as well...
+      def ssdp_response?(resp)
+        (resp[:server] || "")
+          .split(/[,\s]+/)
+          .find { |token| token =~ %r{\AIpBridge/\d+(\.\d+)*\z} }
+      end
+
+      def ssdp_extract(resp)
+        { "id"        => usn_to_id(resp[:usn]),
+          "name"      => resp[:st],
+          "ipaddress" => URI.parse(resp[:location]).host }
+      end
+
+      # TODO: With all the hassle around ID and the fact that I'm essentially
+      # TODO: coercing it down to just MAC address....  Just use the damned IP
+      # TODO: or MAC!
+      def usn_to_id(usn); usn.split(/:/, 3)[1].split(/-/).last; end
+    end
+  end
+end