flic 0.0.5 → 0.0.6

data/lib/flic/protocol/commands/create_scan_wizard.rb

@@ -6,9 +6,7 @@ module Flic
   module Protocol
     module Commands
       class CreateScanWizard < Command
-        endian :little
-
-        uint32 :scan_wizard_id
+        uint32le :scan_wizard_id
       end
     end
   end

data/lib/flic/protocol/commands/create_scanner.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Commands
       class CreateScanner < Command
-        endian :little
-
-        uint32 :scan_id
+        uint32le :scan_id
       end
     end
   end

data/lib/flic/protocol/commands/force_disconnect.rb

@@ -6,8 +6,6 @@ module Flic
   module Protocol
     module Commands
       class ForceDisconnect < Command
-        endian :little
-
         bluetooth_address :bluetooth_address
       end
     end

data/lib/flic/protocol/commands/get_button_uuid.rb

@@ -6,8 +6,6 @@ module Flic
   module Protocol
     module Commands
       class GetButtonUuid < Command
-        endian :little
-
         bluetooth_address :bluetooth_address
       end
     end

data/lib/flic/protocol/commands/get_info.rb

@@ -5,7 +5,6 @@ module Flic
   module Protocol
     module Commands
       class GetInfo < Command
-        endian :little
       end
     end
   end

data/lib/flic/protocol/commands/ping.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Commands
       class Ping < Command
-        endian :little
-
-        uint32 :ping_id
+        uint32le :ping_id
       end
     end
   end

data/lib/flic/protocol/commands/remove_connection_channel.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Commands
       class RemoveConnectionChannel < Command
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
       end
     end
   end

data/lib/flic/protocol/commands/remove_scanner.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Commands
       class RemoveScanner < Command
-        endian :little
-
-        uint32 :scan_id
+        uint32le :scan_id
       end
     end
   end

data/lib/flic/protocol/connection.rb

@@ -2,10 +2,12 @@ require 'flic/protocol'
 
 module Flic
   module Protocol
+    # A wrapper around a socket that allows sending/receiving commands/events
     class Connection
-      class ConnectionClosedError < Error; end
-      class NilResponse < Error; end
+      class UnderlyingSocketClosedError < Error; end
+      class UnexpectedNilReturnValueFromRead < Error; end
 
+      # @return [Socket] the underlying socket
       attr_reader :socket
 
       def initialize(socket)
@@ -14,30 +16,32 @@ module Flic
         @write_semaphore = Mutex.new
       end
 
+      # Sends a command over the socket
+      # @param command [Flic::Protocol::Commands::Command]
       def send_command(command)
         send_packet Protocol.serialize_command(command)
       end
 
+      # Receives a command from the socket
+      # @note This method may block
+      # @return [Flic::Protocol::Commands::Command]
       def recv_command
         Protocol.parse_command(recv_packet)
       end
 
+      # Sends an event over the socket
+      # @param event [Flic::Protocol::Events::Event]
       def send_event(event)
         send_packet Protocol.serialize_event(event)
       end
 
+      # Receives an event from the socket
+      # @note This method may block
+      # @return [Flic::Protocol::Events::Event]
       def recv_event
         Protocol.parse_event(recv_packet)
       end
 
-      def closed?
-        @socket.closed?
-      end
-
-      def close
-        @socket.close
-      end
-
       private
 
       def send_packet(payload)
@@ -46,9 +50,9 @@ module Flic
           @socket.write(packet_header.to_binary_s)
           @socket.write(payload)
         end
-      rescue IOError
-        if closed?
-          raise ConnectionClosedError
+      rescue RuntimeError, IOError
+        if @socket.closed?
+          raise UnderlyingSocketClosedError
         else
           raise
         end
@@ -59,19 +63,18 @@ module Flic
           packet_header = Protocol::PacketHeader.new
           packet_header_bytes = @socket.read packet_header.num_bytes
 
-          raise NilResponse unless packet_header_bytes
+          raise UnexpectedNilReturnValueFromRead unless packet_header_bytes
 
           packet_header.read(packet_header_bytes)
 
           @socket.read(packet_header.byte_length)
         end
-      rescue NilResponse
+      rescue UnexpectedNilReturnValueFromRead
         @socket.close
-
         retry
-      rescue IOError
-        if closed?
-          raise ConnectionClosedError
+      rescue RuntimeError, IOError
+        if @socket.closed?
+          raise UnderlyingSocketClosedError
         else
           raise
         end

data/lib/flic/protocol/events.rb

@@ -2,6 +2,7 @@ require 'flic/protocol'
 
 module Flic
   module Protocol
+    # A namespace module for all of the event classes
     module Events
       autoload :AdvertisementPacket, 'flic/protocol/events/advertisement_packet'
       autoload :BluetoothControllerStateChange, 'flic/protocol/events/bluetooth_controller_state_change'
@@ -47,11 +48,17 @@ module Flic
       }.freeze
   
       OPCODE_EVENT_CLASS = EVENT_CLASS_OPCODE.invert.freeze
-  
+
+      # Finds the event class for a given opcode
+      # @param opcode [Integer]
+      # @return [Class]
       def self.event_class_for_opcode(opcode)
         OPCODE_EVENT_CLASS[opcode]
       end
-  
+
+      # Finds the opcode for a given event class
+      # @param event_class [Class]
+      # @return [Integer]
       def self.opcode_for_event_class(event_class)
         EVENT_CLASS_OPCODE[event_class]
       end

data/lib/flic/protocol/events/advertisement_packet.rb

@@ -8,14 +8,12 @@ module Flic
   module Protocol
     module Events
       class AdvertisementPacket < Event
-        endian :little
-
-        uint32 :scan_id
+        uint32le :scan_id
         bluetooth_address :bluetooth_address
 
         device_name :name
 
-        int8 :rssi
+        int8le :rssi
 
         boolean :is_private
         boolean :is_already_verified

data/lib/flic/protocol/events/bluetooth_controller_state_change.rb

@@ -6,8 +6,6 @@ module Flic
   module Protocol
     module Events
       class BluetoothControllerStateChange < Event
-        endian :little
-
         bluetooth_controller_state :bluetooth_controller_state
       end
     end

data/lib/flic/protocol/events/button_click_or_hold.rb

@@ -7,12 +7,10 @@ module Flic
   module Protocol
     module Events
       class ButtonClickOrHold < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         click_type :click_type
         boolean :was_queued
-        uint32 :time_difference
+        uint32le :time_difference
       end
     end
   end

data/lib/flic/protocol/events/button_single_or_double_click.rb

@@ -7,12 +7,10 @@ module Flic
   module Protocol
     module Events
       class ButtonSingleOrDoubleClick < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         click_type :click_type
         boolean :was_queued
-        uint32 :time_difference
+        uint32le :time_difference
       end
     end
   end

data/lib/flic/protocol/events/button_single_or_double_click_or_hold.rb

@@ -7,12 +7,10 @@ module Flic
   module Protocol
     module Events
       class ButtonSingleOrDoubleClickOrHold < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         click_type :click_type
         boolean :was_queued
-        uint32 :time_difference
+        uint32le :time_difference
       end
     end
   end

data/lib/flic/protocol/events/button_up_or_down.rb

@@ -7,12 +7,10 @@ module Flic
   module Protocol
     module Events
       class ButtonUpOrDown < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         click_type :click_type
         boolean :was_queued
-        uint32 :time_difference
+        uint32le :time_difference
       end
     end
   end

data/lib/flic/protocol/events/connection_channel_removed.rb

@@ -6,9 +6,7 @@ module Flic
   module Protocol
     module Events
       class ConnectionChannelRemoved < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         removed_reason :reason
       end
     end

data/lib/flic/protocol/events/connection_status_changed.rb

@@ -7,9 +7,7 @@ module Flic
   module Protocol
     module Events
       class ConnectionStatusChanged < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         connection_status :connection_status
 
         disconnect_reason :disconnect_reason    # only relevant when connection_status is :disconnected

data/lib/flic/protocol/events/create_connection_channel_response.rb

@@ -7,9 +7,7 @@ module Flic
   module Protocol
     module Events
       class CreateConnectionChannelResponse < Event
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         create_connection_channel_error :error
         connection_status :connection_status
       end

data/lib/flic/protocol/events/event.rb

@@ -6,14 +6,20 @@ module Flic
   module Protocol
     module Events
       class Event < BinData::Record
-        endian :little
-
-        uint8 :opcode, initial_value: -> { init_opcode }
+        uint8le :opcode, initial_value: :class_opcode, assert: :opcode_matcher
 
         private
 
-        def init_opcode
-          Event.opcode_for_event_class(self.class)
+        def class_opcode
+          Events.opcode_for_event_class(self.class)
+        end
+
+        def opcode_matcher
+          if class_opcode
+            class_opcode
+          else
+            true
+          end
         end
       end
     end

data/lib/flic/protocol/events/get_button_uuid_response.rb

@@ -7,8 +7,6 @@ module Flic
   module Protocol
     module Events
       class GetButtonUuidResponse < Event
-        endian :little
-
         bluetooth_address :bluetooth_address
         uuid :uuid
       end

data/lib/flic/protocol/events/get_info_response.rb

@@ -8,18 +8,16 @@ module Flic
   module Protocol
     module Events
       class GetInfoResponse < Event
-        endian :little
-
         bluetooth_controller_state :bluetooth_controller_state
         bluetooth_address :bluetooth_address
         bluetooth_address_type :bluetooth_address_type
 
-        uint8 :maximum_pending_connections
-        int16 :maximum_concurrently_connected_buttons
-        uint8 :current_pending_connections
+        uint8le :maximum_pending_connections
+        int16le :maximum_concurrently_connected_buttons
+        uint8le :current_pending_connections
         boolean :currently_no_space_for_new_connection
 
-        uint16 :verified_buttons_bluetooth_addresses_length
+        uint16le :verified_buttons_bluetooth_addresses_length
         array :verified_buttons_bluetooth_addresses, type: :bluetooth_address, initial_length: :verified_buttons_bluetooth_addresses_length
       end
     end

data/lib/flic/protocol/events/got_space_for_new_connection.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Events
       class GotSpaceForNewConnection < Event
-        endian :little
-
-        uint8 :maximum_concurrently_connected_buttons
+        uint8le :maximum_concurrently_connected_buttons
       end
     end
   end

data/lib/flic/protocol/events/new_verified_button.rb

@@ -6,8 +6,6 @@ module Flic
   module Protocol
     module Events
       class NewVerifiedButton < Event
-        endian :little
-
         bluetooth_address :bluetooth_address
       end
     end

data/lib/flic/protocol/events/no_space_for_new_connection.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Events
       class NoSpaceForNewConnection < Event
-        endian :little
-
-        uint8 :maximum_concurrently_connected_buttons
+        uint8le :maximum_concurrently_connected_buttons
       end
     end
   end

data/lib/flic/protocol/events/ping_response.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Events
       class PingResponse < Event
-        endian :little
-
-        uint32 :ping_id
+        uint32le :ping_id
       end
     end
   end

data/lib/flic/protocol/events/scan_wizard_button_connected.rb

@@ -5,9 +5,7 @@ module Flic
   module Protocol
     module Events
       class ScanWizardButtonConnected < Event
-        endian :little
-
-        uint32 :scan_wizard_id
+        uint32le :scan_wizard_id
       end
     end
   end