flic 0.0.1

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

@@ -0,0 +1,16 @@
+require 'flic/protocol/events'
+require 'flic/protocol/events/event'
+require 'flic/protocol/primitives/scan_wizard_result'
+
+module Flic
+  module Protocol
+    module Events
+      class ScanWizardCompleted < Event
+        endian :little
+
+        uint32 :scan_wizard_id
+        scan_wizard_result :scan_wizard_result
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'flic/protocol/events'
+require 'flic/protocol/events/event'
+
+module Flic
+  module Protocol
+    module Events
+      class ScanWizardFoundPrivateButton < Event
+        endian :little
+
+        uint32 :scan_wizard_id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'flic/protocol/events'
+require 'flic/protocol/events/event'
+require 'flic/protocol/primitives/bluetooth_address'
+require 'flic/protocol/primitives/device_name'
+
+module Flic
+  module Protocol
+    module Events
+      class ScanWizardFoundPublicButton < Event
+        endian :little
+
+        uint32 :scan_wizard_id
+
+        bluetooth_address :bluetooth_address
+        device_name :name
+      end
+    end
+  end
+end

data/lib/flic/protocol/packet_header.rb

@@ -0,0 +1,12 @@
+require 'flic/protocol'
+
+require 'bindata'
+
+module Flic
+  module Protocol
+    class PacketHeader < BinData::Record
+      endian :little
+      uint16 :byte_length
+    end
+  end
+end

data/lib/flic/protocol/primitives.rb

@@ -0,0 +1,22 @@
+require 'flic/protocol'
+
+module Flic
+  module Protocol
+    module Primitives
+      autoload :BluetoothAddress, 'flic/protocol/primitives/bluetooth_address'
+      autoload :BluetoothAddressType, 'flic/protocol/primitives/bluetooth_address_type'
+      autoload :BluetoothControllerState, 'flic/protocol/primitives/bluetooth_controller_state'
+      autoload :Boolean, 'flic/protocol/primitives/boolean'
+      autoload :ClickType, 'flic/protocol/primitives/click_type'
+      autoload :ConnectionStatus, 'flic/protocol/primitives/connection_status'
+      autoload :CreateConnectionChannelError, 'flic/protocol/primitives/create_connection_channel_error'
+      autoload :DeviceName, 'flic/protocol/primitives/device_name'
+      autoload :DisconnectReason, 'flic/protocol/primitives/disconnect_reason'
+      autoload :Enum, 'flic/protocol/primitives/enum'
+      autoload :LatencyMode, 'flic/protocol/primitives/latency_mode'
+      autoload :RemovedReason, 'flic/protocol/primitives/removed_reason'
+      autoload :ScanWizardResult, 'flic/protocol/primitives/scan_wizard_result'
+      autoload :Uuid, 'flic/protocol/primitives/uuid'
+    end
+  end
+end

data/lib/flic/protocol/primitives/bluetooth_address.rb

@@ -0,0 +1,35 @@
+require 'flic/protocol/primitives'
+
+require 'bindata'
+require 'scanf'
+
+module Flic
+  module Protocol
+    module Primitives
+      class BluetoothAddress < BinData::Primitive
+        PRINTF_FORMAT_STRING = '%.2X:%.2X:%.2X:%.2X:%.2X:%.2X'.freeze
+        SCANF_FORMAT_STRING = '%X:%X:%X:%X:%X:%X'.freeze
+
+        array :little_endian_octets, type: :uint8, initial_length: 6
+
+        def get
+          sprintf(PRINTF_FORMAT_STRING, *big_endian_octets)
+        end
+
+        def set(value)
+          self.big_endian_octets = value.scanf(SCANF_FORMAT_STRING)
+        end
+
+        private
+
+        def big_endian_octets
+          little_endian_octets.to_a.reverse
+        end
+
+        def big_endian_octets=(big_endian_octets)
+          self.little_endian_octets = big_endian_octets.to_a.reverse
+        end
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/bluetooth_address_type.rb

@@ -0,0 +1,13 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class BluetoothAddressType < Enum
+        option :public_bluetooth_address_type
+        option :random_bluetooth_address_type
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/bluetooth_controller_state.rb

@@ -0,0 +1,14 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class BluetoothControllerState < Enum
+        option :detached      # The server software has lost the HCI socket to the bluetooth controller and is trying to reconnect.
+        option :resetting     # The server software has just got connected to the HCI socket and initiated a reset of the bluetooth controller.
+        option :attached      # The bluetooth controller has done initialization and is up and running.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/boolean.rb

@@ -0,0 +1,19 @@
+require 'flic/protocol/primitives'
+
+module Flic
+  module Protocol
+    module Primitives
+      class Boolean < BinData::Primitive
+        uint8 :byte
+
+        def get
+          byte != 0x00
+        end
+
+        def set(value)
+          self.byte = value ? 0x01 : 0x00
+        end
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/click_type.rb

@@ -0,0 +1,17 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class ClickType < Enum
+        option :button_down           # The button was pressed.
+        option :button_up             # The button was released.
+        option :button_click          # The button was clicked, and was held for at most 1 second between press and release.
+        option :button_single_click   # The button was clicked once.
+        option :button_double_click   # The button was clicked twice. The time between the first and second press must be at most 0.5 seconds.
+        option :button_hold           # The button was held for at least 1 second.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/connection_status.rb

@@ -0,0 +1,14 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class ConnectionStatus < Enum
+        option :disconnected  # Not currently an established connection, but will connect as soon as the button is pressed and it is in range as long as the connection channel hasn't been removed (and unless maximum number of concurrent connections has been reached or the bluetooth controller has been detached).
+        option :connected     # The physical bluetooth connection has just been established and the server and the button are currently verifying each other. As soon as this is done, it will switch to the ready status.
+        option :ready         # The verification is done and button events may now arrive.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/create_connection_channel_error.rb

@@ -0,0 +1,13 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class CreateConnectionChannelError < Enum
+        option :no_error                              # There were space in the bluetooth controller's white list to accept a physical pending connection for this button
+        option :maximum_pending_connections_reached   # There were no space left in the bluetooth controller to allow a new pending connection
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/device_name.rb

@@ -0,0 +1,44 @@
+require 'flic/protocol/primitives'
+
+require 'bindata'
+
+module Flic
+  module Protocol
+    module Primitives
+      class DeviceName < BinData::Primitive
+        BYTE_LENGTH = 16
+
+        uint8 :byte_length
+        array :bytes, type: :int8, initial_length: BYTE_LENGTH
+
+        def get
+          ''.tap do |string|
+            byte_length.times do |index|
+              break unless index < BYTE_LENGTH
+              string << bytes[index].to_i
+            end
+          end
+        end
+
+        def set(value)
+          byte_length = 0
+          bytes = []
+
+          BYTE_LENGTH.times do |index|
+            char = value[index].to_s
+
+            if char
+              bytes << char.ord
+              byte_length += 1
+            else
+              bytes << 0
+            end
+          end
+
+          self.byte_length = byte_length
+          self.bytes = bytes
+        end
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/disconnect_reason.rb

@@ -0,0 +1,15 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class DisconnectReason < Enum
+        option :unspecified                       # Unknown reason
+        option :connection_establishment_failed   # The bluetooth controller established a connection, but the Flic button didn't answer in time.
+        option :timed_out                         # The connection to the Flic button was lost due to either being out of range or some radio communication problems.
+        option :bonding_keys_mismatch             # The server and the Flic button for some reason don't agree on the previously established bonding keys.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/enum.rb

@@ -0,0 +1,85 @@
+require 'flic/protocol'
+
+require 'bindata'
+
+module Flic
+  module Protocol
+    module Primitives
+      class Enum < BinData::Primitive
+        class Error < StandardError; end
+        class InvalidOptionError < Error; end
+        class InvalidOctetError < Error; end
+
+        class << self
+          def option_octet
+            @option_octet ||= {}
+          end
+
+          def octet_option
+            @octet_option ||= {}
+          end
+
+          def options
+            option_octet.keys
+          end
+
+          def octets
+            octet_option.keys
+          end
+
+          def max_octet
+            octets.max
+          end
+
+          def next_available_octet
+            if max_octet
+              1 + max_octet
+            else
+              0
+            end
+          end
+
+          private
+
+          def option(option, octet = next_available_octet)
+            option_octet[option] = octet
+            octet_option[octet] = option
+          end
+
+          def octet(octet, option)
+            octet_option[octet] = option
+            option_octet[option] = octet
+          end
+        end
+
+        uint8 :octet
+
+        def get
+          if octet_option.has_key?(octet)
+            octet_option[octet]
+          else
+            raise InvalidOctetError, "No such octet `#{octet.inspect}` for enum #{inspect}"
+          end
+        end
+
+        def set(option)
+          if option_octet.has_key?(option)
+            self.octet = self.class.option_octet[option]
+          else
+            raise InvalidOptionError, "No such option `#{option.inspect}` for enum #{inspect}"
+          end
+        end
+
+        private
+
+        def octet_option
+          self.class.octet_option
+        end
+
+        def option_octet
+          self.class.option_octet
+        end
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/latency_mode.rb

@@ -0,0 +1,14 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class LatencyMode < Enum
+        option :normal    # Up to 100 ms latency.
+        option :low       # Up to 17.5 ms latency.
+        option :high      # Up to 275 ms latency.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/removed_reason.rb

@@ -0,0 +1,18 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class RemovedReason < Enum
+        option :removed_by_this_client                # The connection channel was removed by this client.
+        option :force_disconnected_by_this_client     # The connection channel was removed due to a force disconnect by this client.
+        option :force_disconnected_by_other_client    # Another client force disconnected the button used in this connection channel.
+        option :button_is_private                     # The button is not in public mode. Hold it down for 7 seconds while not trying to establish a connection, then try to reconnect by creating a new connection channel.
+        option :verify_timeout                        # After the connection was established, the bonding procedure didn't complete in time.
+        option :internet_backend_error                # The internet request to the Flic backend failed.
+        option :invalid_data                          # According to the Flic backend, this Flic button supplied invalid identity data.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/scan_wizard_result.rb

@@ -0,0 +1,18 @@
+require 'flic/protocol/primitives'
+require 'flic/protocol/primitives/enum'
+
+module Flic
+  module Protocol
+    module Primitives
+      class ScanWizardResult < Enum
+        option :success                 # Indicates that a button was successfully paired and verified. You may now create a connection channel to that button.
+        option :cancelled_by_user       # A CmdCancelScanWizard was sent.
+        option :timeout                 # The scan wizard did not make any progress for some time. Current timeouts are 20 seconds for finding any button, 20 seconds for finding a public button (in case of a private button was found), 10 seconds for connecting the button, 30 seconds for pairing and verifying the button.
+        option :button_private          # First the button was advertising public status, but after connecting it reports private. Probably it switched from public to private just when the connection attempt was started.
+        option :bluetooth_unavailable   # The bluetooth controller is not attached.
+        option :internet_backend_error  # The internet request to the Flic backend failed.
+        option :invalid_data            # According to the Flic backend, this Flic button supplied invalid identity data.
+      end
+    end
+  end
+end

data/lib/flic/protocol/primitives/uuid.rb

@@ -0,0 +1,23 @@
+require 'flic/protocol/primitives'
+
+require 'bindata'
+require 'scanf'
+
+module Flic
+  module Primitives
+    class Uuid < BinData::Primitive
+      PRINTF_FORMAT_STRING = '%.2X%.2X%.2X%.2X-%.2X%.2X-%.2X%.2X-%.2X%.2X-%.2X%.2X%.2X%.2X%.2X%.2X'.freeze
+      SCANF_FORMAT_STRING = '%X%X%X%X-%X%X-%X%X-%X%X-%X%X%X%X%X%X'.freeze
+
+      array :octets, type: :uint8, initial_length: 16
+
+      def get
+        sprintf(PRINTF_FORMAT_STRING, *octets)
+      end
+
+      def set(value)
+        self.octets = value.scanf(SCANF_FORMAT_STRING)
+      end
+    end
+  end
+end