blinkytape-orb 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmMxYTllNTkyNTllOTk2ZTgwMWQxYTgzZGEwODFkNGI0NjRhMGFiYw==
+    YjQxZWMwMDhjNTA2NzQ0ZmMxM2IzMTA3ZGE3OWY5OWM5NDZmN2RiYw==
   data.tar.gz: !binary |-
-    MTg3NDhlZGFiZGM4NzBlNzgyN2MyOTU0ODYwOTlkMjAwNmFjMTlkMA==
+    NjE5ZDU0MDcyYWRiYWMzOTBhYTRhOTMyYzJjY2NlYzMzZTA1ZWNkYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTUyNDAwYjJiNjI1OWNjYjllYThlMTNmMWVhMGY5NDQwOGJkYTU1MzEyMzg3
-    YTFkNGY1OTAyYmU4MmEyYjc1ODcxY2U1Yzc4NjFkZWFhYmE0MzAwZGMxYjUz
-    MDdlOTAxNGE1Y2JiMDc0MjE4NGIzYzdiZjEzODZjNzlhOTQ3NWU=
+    MmViNWViMmNkN2E2N2E2MmI5MjA0M2Y1NWVkY2UxOWYzODVlOTIxMWRjM2Fm
+    NGVmZjQ3MjBhNDI3ZmI1NjU2MzU4N2E3OGFiNTkwOGY2ZTNmYmVmZDgyODc4
+    MWIxYWQxN2Y0NGVhMWQ3YzZjZDUzOTQ0ZjcyMWVkNTEwNDVmZWQ=
   data.tar.gz: !binary |-
-    ZDM2NTlhMTg4YjQ3YWUxODhiMmFkZDU4MTQ4ZWI1NTdkM2M5OGM5MDI2NGJk
-    ZjE2ZjYzMmUxMmUyMjZjMDhmNTNiNzE5MjQ0NzUzOTI3MGViZmUxNjY5NTYy
-    NTIzYzI2MjljOWMzOTM2ZGMwY2NiNWM1NGQ4YjIxMDFkNmRkMjM=
+    ZTg4ZjZmY2FkMDg0YTY0ZTViZDEyOWE1YjY4ODViZDRhODI4ZWE0NzY2YWFh
+    NDM5OWE4N2M2NGQwMDVkMDUzYjgyNjk4MWVjZGM4MjI4ZTZmOTMxNmY1NWNk
+    ODc3MDBjNjQzZWI4Zjc3YmNjZWZmZmUzZjQ0YzM1Y2Y4ZDJhMzU=

data/LICENSE.md

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+## The MIT License (MIT)
 
 Copyright (c) 2016 Jon Tai
 
@@ -20,13 +20,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-
+---
 
 Hardware initialization and interrupt handling arduino code was copied from
 https://github.com/Blinkinlabs/BlinkyTape_Arduino, which has the following
 license:
 
-The MIT License (MIT)
+## The MIT License (MIT)
 
 Copyright (c) 2013 Blinkinlabs, LLC
 

data/README.md

@@ -19,7 +19,7 @@ display everything. This protocol is required for compatibility with BlinkyTape
 software such as [PatternPaint](http://blinkinlabs.com/blinkytape/patternpaint/).
 
 On the other hand, the Ambient Orb accepts a color and animation, encoded as
-ASCII. After recieving an update, the Orb continues to animate (pulse) on its
+ASCII. After recieving a command, the Orb continues to animate (pulse) on its
 own. Like on the BlinkyTape, the button is used to cycle through several
 brightness levels.
 
@@ -30,7 +30,7 @@ differences:
  * Only 6 colors and 4 pulse speeds are accepted (vs. 37 and 10,
    respectively)
  * As a result, the serial protocol is simplified to 1 ASCII character per
-   update
+   command
  * Brightness can be controlled via the serial protocol as well as via the
    hardware button (it's unclear if the Orb allowed this as well)
  * Animations were recreated from memory without comparing them side by side
@@ -79,19 +79,19 @@ sleep(3)
   [ BlinkyTapeOrb::COLOR_YELLOW, BlinkyTapeOrb::PULSE_MED  ],
   [ BlinkyTapeOrb::COLOR_ORANGE, BlinkyTapeOrb::PULSE_MED  ],
   [ BlinkyTapeOrb::COLOR_RED,    BlinkyTapeOrb::PULSE_FAST ],
-].each do |(color, animation)|
-  orb.update(color, animation)
+].each do |(color, pulse)|
+  orb.setColorAndPulse(color, pulse)
   sleep(10)
 end
 ```
 
-# Serial Protocol
+## Serial Protocol
 
-The custom firmware accepts a single ASCII character per update. Regular
-updates encode both a color and pulse speed. Some characters are set aside to
-allow controlling brightness.
+The custom firmware accepts a single ASCII character per command. Color and
+pulse speed commands encode both attributes in a single character. In
+brightness commands, a single character corresponds to a single brightness.
 
-## Regular Updates (Color and Pulse Speed)
+### Color and Pulse Speed
 
 The two lowest bits encode the pulse speed:
 
@@ -123,7 +123,7 @@ In other words, "A" is red with no pulsing, followed by "B" for slow pulsing,
 "C" for medium pulsing, and "D" for fast pulsing. "E" is orange with no
 pulsing, "F" is orange with slow pulsing, etc.
 
-## Brightness Updates
+### Brightness
 
 There are three settings encoded in two bits:
 
@@ -131,14 +131,14 @@ There are three settings encoded in two bits:
 * `01` - Medium
 * `10` - Bright
 
-These are "shifted up" by 97 (ASCII "a"). So "a" is dim, "b" is medium, and "c"
+These are "shifted up" by 60 (ASCII "<"). So "<" is dim, "=" is medium, and ">"
 is bright. The Ruby one-liner for encoding is:
 
 ```ruby
-('a'.ord + brightness).chr
+('<'.ord + brightness).chr
 ```
 
-# Hardware Setup
+## Hardware Setup
 
 I stuck the [BlinkyTape controller board](http://blinkinlabs.myshopify.com/collections/frontpage/products/blinkytape-control-board)
 on the plastic base of the Orb with a small styrofoam riser (poor man's 3D

data/arduino/blinkytape_orb.ino

@@ -45,30 +45,27 @@ void checkSerial() {
     command = Serial.read();
   }
 
-  // handle brightness changes immediately
-  // if command was a brightness change or an invalid command,
-  // swallow it to prevent rushing through the next fade
-  switch (command) {
-    case 97:
-      brightness = BRIGHTNESS_MIN;
-      FastLED.setBrightness(brightness);
-      command = prev_command;
-      break;
-    case 98:
-      brightness = BRIGHTNESS_MED;
-      FastLED.setBrightness(brightness);
-      command = prev_command;
-      break;
-    case 99:
-      brightness = BRIGHTNESS_MAX;
-      FastLED.setBrightness(brightness);
-      command = prev_command;
-      break;
-    default:
-      if (command - 65 >= 24) { // swallow garbage values
-        command = prev_command;
-      }
-      break;
+  // handle certain commands immediately, then swallow the
+  // handled commands to prevent rushing through the next fade
+  if (command >= 60 && command < 63) { // brightness
+    switch (command - 60) { // align to ASCII "<"
+      case 0:
+        brightness = BRIGHTNESS_MIN;
+        break;
+      case 1:
+        brightness = BRIGHTNESS_MED;
+        break;
+      case 2:
+        brightness = BRIGHTNESS_MAX;
+        break;
+    }
+
+    FastLED.setBrightness(brightness);
+    command = prev_command;
+  } else if (command >= 65 && command < 89) { // color and pulse
+    // handled later at low point in fade for a nice smooth transition
+  } else { // invalid command
+    command = prev_command;
   }
 }
 

data/lib/blinkytape-orb.rb

@@ -46,7 +46,7 @@ class BlinkyTapeOrb
     end
   end
 
-  def update(color, pulse)
+  def setColorAndPulse(color, pulse)
     if (color < 0 || color > 5)
       raise ArgumentError, 'color must be between 0 and 5'
     end
@@ -67,7 +67,7 @@ class BlinkyTapeOrb
 
     logger.info("setting brightness=#{brightness}")
 
-    send(('a'.ord + brightness).chr)
+    send(('<'.ord + brightness).chr)
   end
 
   private

data/lib/blinkytape-orb/version.rb

@@ -1,3 +1,3 @@
 class BlinkyTapeOrb
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/lib/blinkytape-orb_spec.rb

@@ -44,7 +44,7 @@ describe BlinkyTapeOrb do
 
   end
 
-  describe '#update' do
+  describe '#setColorAndPulse' do
 
     let (:color) { BlinkyTapeOrb::COLOR_RED }
     let (:pulse) { BlinkyTapeOrb::PULSE_NONE }
@@ -54,7 +54,7 @@ describe BlinkyTapeOrb do
 
       it 'raises ArgumentError' do
         expect {
-          orb.update(color, pulse)
+          orb.setColorAndPulse(color, pulse)
         }.to raise_error(ArgumentError)
       end
     end
@@ -64,33 +64,33 @@ describe BlinkyTapeOrb do
 
       it 'raises ArgumentError' do
         expect {
-          orb.update(color, pulse)
+          orb.setColorAndPulse(color, pulse)
         }.to raise_error(ArgumentError)
       end
     end
 
     context 'with valid arguments' do
-      it 'sends correct update' do
+      it 'sends correct command' do
         expect(orb).to receive(:send).with('A')
-        orb.update(color, pulse)
+        orb.setColorAndPulse(color, pulse)
       end
     end
 
     context 'with purple color' do
       let (:color) { BlinkyTapeOrb::COLOR_PURPLE }
 
-      it 'sends correct update' do
+      it 'sends correct command' do
         expect(orb).to receive(:send).with('U')
-        orb.update(color, pulse)
+        orb.setColorAndPulse(color, pulse)
       end
     end
 
     context 'with fast pulse' do
       let (:pulse) { BlinkyTapeOrb::PULSE_FAST }
 
-      it 'sends correct update' do
+      it 'sends correct command' do
         expect(orb).to receive(:send).with('D')
-        orb.update(color, pulse)
+        orb.setColorAndPulse(color, pulse)
       end
     end
 
@@ -111,8 +111,8 @@ describe BlinkyTapeOrb do
     end
 
     context 'with valid arguments' do
-      it 'sends correct update' do
-        expect(orb).to receive(:send).with('c')
+      it 'sends correct command' do
+        expect(orb).to receive(:send).with('>')
         orb.setBrightness(brightness)
       end
     end
@@ -120,8 +120,8 @@ describe BlinkyTapeOrb do
     context 'with min brightness' do
       let (:brightness) { BlinkyTapeOrb::BRIGHTNESS_MIN }
 
-      it 'sends correct update' do
-        expect(orb).to receive(:send).with('a')
+      it 'sends correct command' do
+        expect(orb).to receive(:send).with('<')
         orb.setBrightness(brightness)
       end
     end
@@ -137,7 +137,7 @@ describe BlinkyTapeOrb do
       io = double('serial_port')
       expect(io).to receive(:write).with('A')
       expect(SerialPort).to receive(:open).and_yield(io)
-      orb.update(BlinkyTapeOrb::COLOR_RED, BlinkyTapeOrb::PULSE_NONE)
+      orb.setColorAndPulse(BlinkyTapeOrb::COLOR_RED, BlinkyTapeOrb::PULSE_NONE)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blinkytape-orb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jon Tai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport