mywx_pusher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9ec0d7c9204f5beaa5097924fc9aba09bf2b55f4b40d69cfd7f66828c1a79ab
+  data.tar.gz: 5362f43110723562fbaeabe0a5991e086f83a692bbb1e3ac19156ffedd809b07
+SHA512:
+  metadata.gz: 06be247c4db31474969c10dd5b7a576a8e488726d35a818f320e8ffb32ca92dfb76c20b4889c4b55c78028dfbc13964334ba3b51604f7c5207c7d7c8b93534b9
+  data.tar.gz: 0a04a1e7c903ed4ffcef33799e143aaa51fa9ec55d06f9fa61b1face84e2631a91f61beb476f97858255ded81314421af6b167cdc6c40726363f384cbb2f3351

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.gem
+
+.byebug_history
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+Layout/LineLength:
+  Max: 120
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/FormatString:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/SymbolArray:
+  MinSize: 1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mywx_pusher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    mywx_pusher (0.1.0)
+      weatherlink (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby-units (2.3.1)
+    unicode-display_width (1.7.0)
+    weatherlink (0.1.0)
+      ruby-units (~> 2.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mywx_pusher!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jeremy Cole
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+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.

data/README.md

@@ -0,0 +1,34 @@
+# MyWX Pusher
+
+MyWX Pusher allows you to send the data directly from a Davis Instruments weather station using a [WeatherLink Live](https://www.davisinstruments.com/weatherlink/) or [AirLink](https://www.davisinstruments.com/airlink/) to [MyWX](https://www.mywx.live/) for real time display on your weather panel.
+
+## Installation
+
+Or install it yourself as:
+
+```
+$ gem install mywx_pusher
+```
+
+## Usage
+
+Create your station on [MyWX](https://www.mywx.live/) and get the station slug and secret key, and run `mywx_pusher` as follows:
+
+```
+mywx_pusher -w <local ip address> -s <station slug> -k <secret key>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [jeremycole/mywx_pusher](https://github.com/jeremycole/mywx_pusher).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mywx_pusher'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mywx_pusher

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'logger'
+require 'optparse'
+require 'ostruct'
+require 'mywx_pusher'
+
+class MywxPusherCommand
+  attr_reader :options
+
+  class BadOptionError < StandardError; end
+  class CollectError < StandardError; end
+  class PushError < StandardError; end
+
+  def initialize
+    initialize_options
+  end
+
+  def initialize_options
+    @options = OpenStruct.new(
+      mywx_base_uri: 'https://www.mywx.live/',
+      mywx_station_slug: nil,
+      mywx_secret_key: nil,
+      interval: 10
+    )
+  end
+
+  def logger
+    @logger ||= Logger.new($stderr, level: :info)
+  end
+
+  def option_parser
+    @option_parser ||= OptionParser.new do |opts|
+      opts.on('-h', '--help', 'Show this help.') do
+        puts opts
+        exit 0
+      end
+
+      opts.on('-d', '--debug', 'Enable debug mode') { logger.level = Logger::DEBUG }
+
+      opts.on('-w', '--weatherlink-host=HOST', '') { |o| options.weatherlink_host = o }
+
+      opts.on('-b', '--mywx-base-uri=URI', '') { |o| options.mywx_base_uri = o }
+      opts.on('-s', '--mywx-station-slug=SLUG', '') { |o| options.mywx_station_slug = o }
+      opts.on('-k', '--mywx-secret-key=KEY', '') { |o| options.mywx_secret_key = o }
+
+      opts.on('-i', '--interval=SECONDS', '') { |o| options.interval = o.to_i }
+    end
+  end
+
+  def parse_options(args)
+    option_parser.parse!(args)
+    validate_options
+
+    self
+  end
+
+  def validate_options
+    raise BadOptionError, 'Missing required --mywx-station-slug/-s option' unless options.mywx_station_slug
+    raise BadOptionError, 'Missing required --mywx-secret-key/-k option' unless options.mywx_secret_key
+    raise BadOptionError, 'Missing required --weatherlink-host/-w option' unless options.weatherlink_host
+
+    true
+  end
+
+  def mywx_push_data_uri
+    @mywx_push_data_uri ||= URI.join(options.mywx_base_uri, "/stations/#{options.mywx_station_slug}/push_data")
+  end
+
+  def collect_data
+    logger.debug("Collecting data from #{options.weatherlink_host}...")
+
+    ts = Time.now.to_i
+
+    begin
+      current_conditions = client.current_conditions
+    rescue StandardError => e
+      raise CollectError, e
+    end
+
+    iss_record = current_conditions.find { |sd| sd.record_type.id == 1 }
+    lss_pressure_record = current_conditions.find { |sd| sd.record_type.id == 3 }
+
+    data = {
+      ts: ts,
+      temperature: iss_record.temp.scalar.to_f.round(2),
+      dew_point: iss_record.dew_point.scalar.to_f.round(2),
+      humidity: iss_record.hum.scalar.to_f.round(2),
+      pressure: lss_pressure_record.bar_sea_level.scalar.to_f.round(2),
+      wind_speed: iss_record.wind_speed_avg_last_1_min.scalar.to_f.round(2),
+      wind_direction: iss_record.wind_dir_scalar_avg_last_1_min.scalar.to_i,
+      rain_rate: iss_record.rain_rate_last.scalar.to_f.round(2),
+      solar_radiation: iss_record.solar_rad.scalar.to_f.round(2),
+    }
+
+    logger.debug("Collected data (#{data.size} variables): #{data}")
+
+    data
+  end
+
+  def post_data(data)
+    logger.debug("Sending data (#{data.size} variables)...")
+    response = Net::HTTP.post_form(mywx_push_data_uri, { secret_key: options.mywx_secret_key, data: data.to_json })
+
+    unless response.code == '200'
+      raise PushError, "Response from MyWX API: #{response.code} #{response.message}: #{response.body}"
+    end
+
+    logger.debug("Response from MyWX API: #{response.code} #{response.message}")
+    true
+  end
+
+  def client
+    @client ||= WeatherLink::LocalClient.new(
+      host: options.weatherlink_host,
+      desired_units: WeatherLink::METRIC_WEATHER_UNITS
+    )
+  end
+
+  def run
+    logger.info(
+      format(
+        'Collecting from %s, pushing to %s every %i seconds...',
+        options.weatherlink_host,
+        mywx_push_data_uri,
+        options.interval
+      )
+    )
+
+    loop do
+      begin
+        data = collect_data
+        post_data(data)
+        logger.info("Collected and pushed #{data.size} variables.")
+      rescue StandardError => e
+        logger.warn("Failed to collect or send data: #{e.class.name}: #{e}")
+      end
+      sleep options.interval # TODO: should try to align
+    end
+  end
+end
+
+MywxPusherCommand.new.parse_options(ARGV).run

data/lib/mywx_pusher.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'mywx_pusher/version'
+require 'weatherlink'
+
+module MywxPusher
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/mywx_pusher/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MywxPusher
+  VERSION = '0.1.0'
+end

data/mywx_pusher.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mywx_pusher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mywx_pusher'
+  spec.version       = MywxPusher::VERSION
+  spec.authors       = ['Jeremy Cole']
+  spec.email         = ['jeremy@jcole.us']
+
+  spec.summary       = 'Weather data pusher for MyWX'
+  spec.description   = 'Push weather data from a Davis Instruments weather station to MyWX in real time'
+  spec.homepage      = 'https://github.com/jeremycole/mywx_pusher'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rake', '~> 12.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('rubocop', '~> 1.7')
+
+  spec.add_dependency('weatherlink', '~> 0.1')
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mywx_pusher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Cole
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: weatherlink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Push weather data from a Davis Instruments weather station to MyWX in
+  real time
+email:
+- jeremy@jcole.us
+executables:
+- mywx_pusher
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mywx_pusher
+- lib/mywx_pusher.rb
+- lib/mywx_pusher/version.rb
+- mywx_pusher.gemspec
+homepage: https://github.com/jeremycole/mywx_pusher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jeremycole/mywx_pusher
+  source_code_uri: https://github.com/jeremycole/mywx_pusher
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Weather data pusher for MyWX
+test_files: []