hacklet 0.5.0 → 0.5.1

data/README.md

@@ -1,16 +1,16 @@
 # Hacklet [![Build Status](https://travis-ci.org/mcolyer/hacklet.png)](https://travis-ci.org/mcolyer/hacklet)
 
-A library, written in Ruby, for controlling the [Modlet] (smart) outlet.
+A library, written in Ruby, for controlling the [Modlet][modlet] (smart) outlet.
 
 If you haven't heard of the Modlet before, it's a smart outlet cover
-which allows you to convert any outlet into your house into a smart
+which allows you to convert any outlet in your house into a smart
 outlet. This means that you can control whether a plug is on or off and
 you can also determine how much energy it's using with a sampling
 frequency of 10 seconds.
 
 There are alot of other similar products but this is the first one that
-I've see that [costs $50][amazon] and includes control as well as monitoring of
-the independent sockets.
+I've seen that [costs $50][amazon] and includes control as well as
+monitoring of the both sockets independently.
 
 ## Why
 
@@ -26,25 +26,46 @@ control and availability of the data.
 
 ## Getting Started
 
-Right now things are pretty rough and won't work without modifying
-`bin/hacklet`. Eventually the `hacklet` script will allow for specifying
-which Modlet and socket you'd like to read or control.
+```shell
+gem install hacklet
 
-```
-bundle install
+# Load the USB-to-serial kernel driver, this only works with Linux currently
 sudo modprobe ftdi_sio vendor=0x0403 product=0x8c81
-bin/hacklet
+
+# Add the device to the network, keep a copy of the network ids (ie 0xDEED)
+hacklet commission
+
+# Get the samples from the top socket on the device registered as 0xDEED
+hacklet read -n 0xDEED -s 0
+
+# Turn the top socket off
+hacklet off -n 0xDEED -s 0
+
+# And back on again
+hacklet on -n 0xDEED -s 0
 ```
 
-## Status
+## Contributing
+
+All contributions are welcome (bug reports, bug fixes, documentation or
+new features)!  If you're looking for something to do check the [issue]
+list and see if there's something already there. If you've got a new
+idea, feel free to create an issue for discussion.
+
+To get a general understanding of how things work, checkout the
+[developer wiki]
+
+### Getting Started
 
-* [X] Reading Data
-* [X] Controlling Sockets
-* [X] Multiple Modlet Support
-* [X] Commissioning New Devices
-* [X] Useful utility
-* [ ] Set time on New Devices
-* [ ] Documentation
+* Checkout the repository
+* Install dependencies `bundle install`
+* Create a feature branch `git checkout -b short-name`
+* Run tests `bundle exec rake`
+* Write your feature (and tests)
+* Run tests `bundle exec rake`
+* Create a pull request
 
-[Modlet]: http://themodlet.com
+[modlet]: http://themodlet.com
 [amazon]: http://www.amazon.com/ThinkEco-TE1010-Modlet-Starter-White/dp/B00AAT43OA/
+[issue]: https://github.com/mcolyer/hacklet/issues
+[developer wiki]: https://github.com/mcolyer/hacklet/wiki

data/hacklet.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "slop", "~>3.4.0"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "timecop"
 end

data/lib/hacklet/dongle.rb

@@ -38,16 +38,18 @@ module Hacklet
     def commission
       require_session
 
+      response = nil
       begin
         unlock_network
         Timeout.timeout(30) do
+          @logger.info("Listening for devices ...")
           loop do
-            @logger.info("Listening for devices ...")
             buffer = receive(4)
             buffer += receive(buffer.bytes.to_a[3]+1)
             if buffer.bytes.to_a[1] == 0xa0
               response = BroadcastResponse.read(buffer)
               @logger.info("Found device 0x%x on network 0x%x" % [response.device_id, response.network_id])
+              break
             end
           end
         end
@@ -55,6 +57,8 @@ module Hacklet
       ensure
         lock_network
       end
+
+      update_time(response.network_id) if response
     end
 
     # Public: Selects the network.
@@ -159,6 +163,22 @@ module Hacklet
       BootConfirmResponse.read(receive(6))
     end
 
+    # Private: Updates the time of a device.
+    #
+    # This must be executed within an open session. I'm guessing it selects the
+    # network.
+    #
+    # network_id - 2 byte identified for the network.
+    #
+    # Returns nothing.
+    def update_time(network_id)
+      require_session
+
+      transmit(UpdateTimeRequest.new(:network_id => network_id))
+      UpdateTimeAckResponse.read(receive(6))
+      UpdateTimeResponse.read(receive(8))
+    end
+
     # Private: Initializes the serial port
     #
     # port - the String to the device to open as a serial port.

data/lib/hacklet/messages.rb

@@ -49,16 +49,16 @@ module Hacklet
     endian :big
 
     uint8  :header, :check_value => lambda { value == 0x02 }
-    uint16  :command, :check_value => lambda { value == 0xA013 }
+    uint16 :command, :check_value => lambda { value == 0xA013 }
     uint8  :payload_length, :check_value => lambda { value == 11 }
 
     uint16 :network_id
     uint64 :device_id
 
     # TODO: Not sure why this is here.
-    uint8 :data
+    uint8  :data
 
-    uint8 :checksum, :check_value => lambda { calculate_checksum == checksum }
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
   end
 
   class LockResponse < Message
@@ -68,9 +68,34 @@ module Hacklet
     uint16 :command, :check_value => lambda { value == 0xA0F9 }
     uint8  :payload_length, :check_value => lambda { value == 1 }
 
-    uint8be :data, :check_value => lambda { value == 0x00 }
+    uint8 :data, :check_value => lambda { value == 0x00 }
 
-    uint8 :checksum, :check_value => lambda { calculate_checksum == checksum }
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
+  end
+
+  class UpdateTimeAckResponse < Message
+    endian :big
+
+    uint8  :header, :check_value => lambda { value == 0x02 }
+    uint16 :command, :check_value => lambda { value == 0x4022 }
+    uint8  :payload_length, :check_value => lambda { value == 1 }
+
+    uint8  :data, :check_value => lambda { value == 0x00 }
+
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
+  end
+
+  class UpdateTimeResponse < Message
+    endian :big
+
+    uint8  :header, :check_value => lambda { value == 0x02 }
+    uint16 :command, :check_value => lambda { value == 0x40a2 }
+    uint8  :payload_length, :check_value => lambda { value == 3 }
+
+    uint16 :network_id
+    uint8  :data, :check_value => lambda { value == 0x00 }
+
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
   end
 
   class HandshakeResponse < Message
@@ -80,9 +105,9 @@ module Hacklet
     uint16 :command, :check_value => lambda { value == 0x4003 }
     uint8  :payload_length, :check_value => lambda { value == 1 }
 
-    uint8be :data, :check_value => lambda { value == 0x00 }
+    uint8  :data, :check_value => lambda { value == 0x00 }
 
-    uint8 :checksum, :check_value => lambda { calculate_checksum == checksum }
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
   end
 
   class AckResponse < Message
@@ -92,17 +117,17 @@ module Hacklet
     uint16 :command, :check_value => lambda { value == 0x4024 }
     uint8  :payload_length, :check_value => lambda { value == 1 }
 
-    uint8be :data, :check_value => lambda { value == 0x00 }
+    uint8  :data, :check_value => lambda { value == 0x00 }
 
-    uint8 :checksum, :check_value => lambda { calculate_checksum == checksum }
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
   end
 
   class SamplesResponse < Message
     endian :big
 
-    uint8  :header, :check_value => lambda { value == 0x02 }
-    uint16 :command, :check_value => lambda { value == 0x40A4 }
-    uint8  :payload_length
+    uint8    :header, :check_value => lambda { value == 0x02 }
+    uint16   :command, :check_value => lambda { value == 0x40A4 }
+    uint8    :payload_length
 
     uint16   :network_id
     uint16   :channel_id
@@ -130,9 +155,9 @@ module Hacklet
     uint16 :command, :check_value => lambda { value == 0x4023 }
     uint8  :payload_length, :check_value => lambda { value == 1 }
 
-    uint8be :data, :check_value => lambda { value == 0x00 }
+    uint8  :data, :check_value => lambda { value == 0x00 }
 
-    uint8 :checksum, :check_value => lambda { calculate_checksum == checksum }
+    uint8  :checksum, :check_value => lambda { calculate_checksum == checksum }
   end
 
   class BootRequest < Message
@@ -142,7 +167,7 @@ module Hacklet
     uint16 :command, :initial_value => 0x4004
     uint8  :payload_length
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
   end
 
   class BootConfirmRequest < Message
@@ -152,7 +177,7 @@ module Hacklet
     uint16 :command, :initial_value => 0x4000
     uint8  :payload_length
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
   end
 
   class UnlockRequest < Message
@@ -165,7 +190,7 @@ module Hacklet
     # TODO: What is this?
     uint32 :data, :initial_value => 0xFCFF9001
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
   end
 
   class LockRequest < Message
@@ -178,7 +203,20 @@ module Hacklet
     # TODO: What is this?
     uint32 :data, :initial_value => 0xFCFF0001
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
+  end
+
+  class UpdateTimeRequest < Message
+    endian :big
+
+    uint8    :header, :initial_value => 0x02
+    uint16   :command, :initial_value => 0x4022
+    uint8    :payload_length, :initial_value => 6
+
+    uint16   :network_id
+    uint32le :time, :initial_value => lambda { Time.now.to_i }
+
+    uint8    :checksum, :value => :calculate_checksum
   end
 
   class HandshakeRequest < Message
@@ -192,7 +230,7 @@ module Hacklet
     # TODO: What is this?
     uint16 :data, :initial_value => 0x0500
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
   end
 
   class SamplesRequest < Message
@@ -207,7 +245,7 @@ module Hacklet
     # TODO: What is this?
     uint16 :data, :initial_value => 0x0A00
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
   end
 
   class ScheduleRequest < Message
@@ -221,7 +259,7 @@ module Hacklet
     uint8  :channel_id
     array  :schedule, :type => [:uint8], :initial_length => 56
 
-    uint8 :checksum, :value => :calculate_checksum
+    uint8  :checksum, :value => :calculate_checksum
 
     def always_off!
       bitmap = [0x7f]*56

data/lib/hacklet/version.rb

@@ -1,3 +1,3 @@
 module Hacklet
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/hacklet/dongle_spec.rb

@@ -48,12 +48,16 @@ describe Hacklet::Dongle do
     serial_port.should_receive(:read).and_return([0x02, 0xa0, 0x13, 0x0b].pack('c'*4))
     serial_port.should_receive(:read).and_return([0x66, 0xad, 0xcc, 0x1f, 0x10, 0x00,
       0x00, 0x58, 0x4f, 0x80, 0x8e, 0xa9].pack('c'*12))
-    serial_port.should_receive(:read).and_raise(Timeout::Error)
 
     # Lock Network
     serial_port.should_receive(:write).with([0x02, 0xA2, 0x36, 0x04, 0xFC, 0xFF, 0x00, 0x01, 0x92].pack('c'*9))
     serial_port.should_receive(:read).and_return([0x02, 0xA0, 0xF9, 0x01, 0x00, 0x58].pack('c'*6))
 
+    # Update Time
+    serial_port.should_receive(:write).and_return([0x02, 0x40, 0x22, 0x06, 0x66, 0xAD, 0xdb, 0xb4, 0xa8, 0x51, 0x0b].pack('c'*11))
+    serial_port.should_receive(:read).and_return([0x02, 0x40, 0x22, 0x01, 0x00, 0x63].pack('c'*6))
+    serial_port.should_receive(:read).and_return([0x02, 0x40, 0xA2, 0x03, 0x66, 0xAD, 0x00, 0x2a].pack('c'*8))
+
     serial_port.should_receive(:close)
     serial_port.stub!(:closed?).and_return(false)
     subject.should_receive(:open_serial_port).and_return(serial_port)
@@ -61,7 +65,9 @@ describe Hacklet::Dongle do
     subject.should_receive(:boot_confirm)
 
     subject.open_session do |session|
-      session.commission
+      Timecop.freeze(Time.at(0x51a8b4db)) do
+        session.commission
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'hacklet'
+require 'timecop'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hacklet
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An Open Source client for the Modlet (smart) outlet
 email:
 - matt@colyer.name