home_assistant-ble 0.1.0.pre.alpha.pre.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 226e1271e9fbd7316b0b6601ee1b53f0f81556d2
+  data.tar.gz: 1f0bc53079aea88b05a8e1b06068d9ce58f72d0f
+SHA512:
+  metadata.gz: 6b5d590f488f22e7bf2a9c54d1634b920e6b2c830dc2b5eda5fee8c778502c7e9a085831ba6ec8f3cf8937e79e1f748658794de34bfd17fa1a003c9540bebf92
+  data.tar.gz: 9bcdd9218d973ea3b12469f1471e49ffa8ef6a2938627f66d6a604dfe349044aa281ed3529fe9fe0ce4c47de0b99a60d55341d5b54601e494adcebd86e5f1063

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 140
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+- 2.4.0
+before_install: gem install bundler -v 1.13.7
+deploy:
+  provider: rubygems
+  api_key:
+    secure: BY92AHiphWOXtY7gGs83haZwZb+HeM+f12omyu5+Kv98WzNt85BmWgrstMQd9+kZXXbbU4kTIHgpir7CQlBHq+fMLKV5mgNHYwPpEe3l9Fe1lxIrPRV7uKIGxHiJvKUgwMPNfAHIIiN4GyhJr3Fb33i8sJ8WvGwYzQYgSDKOVOzUtx3aVAFh+6AmCaM4kCAukLn3c3s6PNvCIAIELl/GusZzDVRYHRdVoYKoAfA8beB+xSS5YykUIiQKKIXPRghuwynbyak96n1yIcDet5LDgBq3PYe0uQP4yLRI4UbN5WQbPVbHNFZT7TRYvYqIhQdePzsf4GEP+1hr7e4q7n0HoRnKXe9u6kcUlXCIj874wYw9WG11aehlYeyzQNWXpTsofz9GlDacVGEB7L7KZcEtccbApN1c9SfzkaMj1qLN8noRQ2oD4NzW1DZ58FjXUD6Igdzy3r0AOKrrTxCy8j66l/zB+p77urhgUs08+jhV9UIgB/plrrhRbg/eHZEnU/O6XEjEdi2zpClM3jnR4ZkVcopIdyHhLbImGQvGITYNh9WfjWA/AbL5OTJQT3GRNL++fQnXSNVSZQlv/5Fet5YrCw19fOyQGO1xDY+TguCfS5OhqhpYMbUUgX5LMKuKGCFJdTL+9xypq9FlPEHqJI67TFHPcn18JpO5dUjbx/yBUDI=
+  gem: home_assistant-ble
+  on:
+    repo: kamaradclimber/home_assistant-ble

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# HomeAssistant::Ble
+
+Companion app from home-assistant sending BLE events.
+
+Since HA does not cope well with bluetooth device tracking (https://home-assistant.io/components/device_tracker.bluetooth_le_tracker/) this app runs along home-assistant and sends device tracking to it.
+
+## Installation
+
+
+$ `gem install home_assistant-ble`
+
+## Usage
+
+Run `home_assistant-ble [your config file]` binary.
+
+More instruction to launch this as a service with systemd (TODO).
+
+## Configuration
+
+```
+interval: 30 # in seconds, interval between device scan
+grace_period: 60 # in seconds, delay before considering a device has disappeared
+home_assistant_url: http://localhost:8123 # url to contact home-assistant
+home_assistant_password: xxxxx # a non mandatory password to authenticate to home-assistant api
+home_assistant_devices: # devices whose activity will be sent to home-assistant.
+  F0:5C:F4:EA:BF:C8: nut1 # [macaddress]: [identifier for home-assistant]
+```
+
+All presented settings (except `home_assistant_devices`) are set to their _default_  values. They don't need to be set.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+task default: :rubocop

data/bin/home_assistant-ble

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'home_assistant/ble'
+require 'yaml'
+
+config_file = ARGV.shift
+config = {}
+if config_file
+  config = YAML.load_file(config_file)
+else
+  $stderr.puts 'No configuration file specified, will use all default values'
+end
+
+detector = HomeAssistant::Ble::Detector.new(config)
+
+detector.run

data/example_config.yml

@@ -0,0 +1,6 @@
+interval: 30 # in seconds
+grace_period: 60 # in seconds
+home_assistant_url: http://localhost:8123
+# home_assistant_password: xxxxx
+home_assistant_devices:
+  F0:5C:F4:EA:BF:C8: nut1

data/home_assistant-ble.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'home_assistant/ble/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'home_assistant-ble'
+  spec.version       = HomeAssistant::Ble::VERSION
+  spec.version       = "#{spec.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+  spec.version       = ENV['TRAVIS_TAG'] unless ENV['TRAVIS_TAG'].empty?
+  spec.authors       = ['Grégoire Seux']
+  spec.email         = ['grego_homeassistant@familleseux.net']
+
+  spec.summary       = 'Companion app for home-assistant sending event about BLE devices'
+  spec.description   = 'home-assistant does not cope well with bluetooth on raspberry pi. This gem sends event to HA.'
+  spec.homepage      = 'https://github.com/kamaradclimber/home_assistant-ble'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_runtime_dependency 'ble'
+  spec.add_runtime_dependency 'mash'
+end

data/lib/home_assistant/ble/version.rb

@@ -0,0 +1,5 @@
+module HomeAssistant
+  module Ble
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/home_assistant/ble.rb

@@ -0,0 +1,120 @@
+require 'home_assistant/ble/version'
+require 'ble'
+require 'mash'
+require 'net/http'
+require 'uri'
+require 'json'
+
+module HomeAssistant
+  module Ble
+    class Detector
+      attr_reader :config, :known_devices
+
+      def initialize(config)
+        @config = Mash.new(config)
+        @known_devices = {}
+      end
+
+      # polling interval
+      def interval
+        config['interval'] || 30
+      end
+
+      # time after which a device is considered as disappeared
+      def grace_period
+        config['grace_period'] || 60
+      end
+
+      def home_assistant_url
+        config['home_assistant_url'] || 'http://localhost:8123'
+      end
+
+      def home_assistant_password
+        config['home_assistant_password']
+      end
+
+      def home_assistant_devices
+        # TODO: read this from HA known_devices.yml
+        config['home_assistant_devices'] || {}
+      end
+
+      def run
+        loop do
+          detect_devices
+          clean_devices
+          debug "Will sleep #{interval}s before relisting devices"
+          sleep interval
+        end
+      end
+
+      private
+
+      def log(message)
+        puts message
+      end
+
+      def debug(message)
+        log 'Set DEBUG environment variable to activate debug logs' unless ENV['DEBUG'] || @debug_tip
+        @debug_tip = true
+        print '(debug) '
+        puts message if ENV['DEBUG']
+      end
+
+      def detect_devices
+        adapter.devices.each do |name|
+          unless known_devices.key?(name)
+            log "Just discovered #{name}"
+            home_assistant_devices[name] && update_home_assistant(home_assistant_devices[name], :home)
+          end
+          known_devices[name] = Time.now
+        end
+      end
+
+      def clean_devices
+        disappeared = (known_devices.keys - adapter.devices).select do |name|
+          Time.now - known_devices[name] > grace_period
+        end
+        disappeared.each do |name|
+          known_devices.delete(name).tap do |last_seen|
+            log "#{name} has disappeared (last seen #{last_seen})"
+            home_assistant_devices[name] && update_home_assistant(home_assistant_devices[name], :not_home)
+          end
+        end
+      end
+
+      def update_home_assistant(ha_name, state)
+        uri = URI.join(home_assistant_url, "api/states/device_tracker.#{ha_name}")
+        request = Net::HTTP::Post.new(uri)
+        request.content_type = 'application/json'
+        request['X-Ha-Access'] = home_assistant_password if home_assistant_password
+        request.body = JSON.dump('state' => state)
+        req_options = { use_ssl: uri.scheme == 'https' }
+
+        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          http.request(request)
+        end
+
+        if response.code.to_i == 200
+          debug "State update #{state} sent to HA for #{ha_name}"
+          debug response.body
+        else
+          log "Error while sending #{state} to HA form #{ha_name}."
+          log "URI was: #{uri}. Response was:"
+          log response.body
+        end
+      end
+
+      def adapter
+        @adapter ||= begin
+                       iface = BLE::Adapter.list.first
+                       debug "Selecting #{iface} to listen for bluetooth events"
+                       raise 'Unable to find a bluetooth device' unless iface
+                       BLE::Adapter.new(iface).tap do |a|
+                         debug 'Activating discovery'
+                         a.start_discovery
+                       end
+                     end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: home_assistant-ble
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.pre.7
+platform: ruby
+authors:
+- Grégoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ble
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: home-assistant does not cope well with bluetooth on raspberry pi. This
+  gem sends event to HA.
+email:
+- grego_homeassistant@familleseux.net
+executables:
+- home_assistant-ble
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/home_assistant-ble
+- example_config.yml
+- home_assistant-ble.gemspec
+- lib/home_assistant/ble.rb
+- lib/home_assistant/ble/version.rb
+homepage: https://github.com/kamaradclimber/home_assistant-ble
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Companion app for home-assistant sending event about BLE devices
+test_files: []