sgslib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fc3371c28ba4e23106c0a6ec7438269c4e127a4
+  data.tar.gz: 513b37fe44496a798e3c9a332fa7446bd35d7a93
+SHA512:
+  metadata.gz: cc840557ca82d76640c300cd2fb93745da198f5827444ff38afd84c2a11aabfd429dcfd600cc54ea30020c28acecd2a9b5719f820a8d277e8060e5ed97e20d73
+  data.tar.gz: a574b15c37a867713b01cf4583edfafa4623461c433d30ad87512d47b507d76224abe8b91aaaefed6ad65d4a3e8d57ed46f1921ce8e461aebd41f5fa3a8979b9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tynan@hpe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sgslib.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dermot Tynan
+
+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,40 @@
+# Sailboat Guidance System
+
+The Sailboat Guidance System is a Ruby gem for managing an autonomous, robotic sailboat.
+As it stands, it is quite specific to the [Beoga Beag](http://beogabeag.com) boat, but
+this will change, over time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sgslib'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sgslib
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 https://github.com/[USERNAME]/sgs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sgslib"
+
+# 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

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/lib/sgs/alarm.rb

@@ -0,0 +1,103 @@
+#
+# Copyright (c) 2013, Kalopa Research.  All rights reserved.  This is free
+# software; you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation;
+# either version 2, or (at your option) any later version.
+#
+# It is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this product; see the file COPYING.  If not, write to the Free
+# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# THIS SOFTWARE IS PROVIDED BY KALOPA RESEARCH "AS IS" AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL KALOPA RESEARCH BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+##
+# Routines for handling sailboat alarms. Note that this is the definitive
+# list of alarms on the system. To add or modify an alarm, do so here.
+#
+require 'date'
+
+module SGS
+  ##
+  # Deal with alarm subsystem.
+  #
+  class Alarm < RedisBase
+    attr_accessor :last_report, :time
+
+    OTTO_RESTART = 0
+    RUDDSRV_FAULT = 1
+    SAILSRV_FAULT = 2
+    VBATT_CRITICAL = 3
+    VBATT_UNDERVOLTAGE = 4
+    VBATT_OVERVOLTAGE = 5
+    IBATT_INRUSH = 6
+    IBATT_DRAIN = 7
+    VSOLAR_OVERVOLTAGE = 8
+    COMPASS_ERROR = 9
+    COMPASS_NOREAD = 10
+    WDI_STUCK = 11
+    WDI_NOREAD = 12
+    RUDDER_NOZERO = 13
+    SAIL_NOZERO = 14
+    MOTHER_UNRESP = 15
+
+    MISSION_COMMENCE = 16
+    MISSION_COMPLETE = 17
+    MISSION_ABORT = 18
+    WAYPOINT_REACHED = 19
+    CROSS_TRACK_ERROR = 20
+    INSIDE_FENCE = 21
+
+    MESSAGES = [
+      "OTTO Restarted",
+      "Rudder Servo Fault",
+      "Sail Servo Fault",
+      "Battery voltage is critically low",
+      "Battery voltage is low",
+      "Battery voltage is too high",
+      "Battery inrush current",
+      "Battery drain current",
+      "Solar voltage is too high",
+      "Compass module error",
+      "Compass not responding",
+      "WDI reading is misaligned",
+      "Cannot read from the WDI",
+      "Cannot zero the rudder position",
+      "Cannot zero the sail position",
+      "Mother is unresponsive",
+      "Mission has commenced",
+      "Mission is completed",
+      "*** MISSION ABORT ***",
+      "Waypoint has been reached",
+      "Significant cross-track error",
+      "Vessel is inside the fence"
+    ].freeze
+
+    def initialize
+      @count = 0
+      @last_report = nil
+      @time = Array.new(32, Time.at(0))
+      super
+    end
+
+    #
+    # Convert an alarm number into a string.
+    def name(alarmno)
+      MESSAGES[alarmno]
+    end
+  end
+end

data/lib/sgs/command.rb

@@ -0,0 +1,167 @@
+#
+# Copyright (c) 2013, Kalopa Research.  All rights reserved.  This is free
+# software; you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation;
+# either version 2, or (at your option) any later version.
+#
+# It is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this product; see the file COPYING.  If not, write to the Free
+# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# THIS SOFTWARE IS PROVIDED BY KALOPA RESEARCH "AS IS" AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL KALOPA RESEARCH BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+##
+# Routines for handling sailboat alarms. Note that this is the definitive
+# list of alarms on the system. To add or modify an alarm, do so here.
+#
+module SGS
+  ##
+  # Deal with command subsystem.
+  #
+  # This code handles the Fonz packet commands.
+  #
+  class Command < RedisBase
+    attr_accessor :last_received, :time
+
+    FONZ_PING = 0
+    FONZ_MAGIC = 1
+    FONZ_ACK = 2
+
+    FONZ_GET_TIMEL = 4
+    FONZ_TIME_DATAL = 5
+    FONZ_GET_TIMEH = 6
+    FONZ_TIME_DATAH = 7
+
+    FONZ_GET_VOLTS1 = 8
+    FONZ_VOLTS1_DATA = 9
+    FONZ_GET_VOLTS2 = 10
+    FONZ_VOLTS2_DATA = 11
+    FONZ_GET_VOLTS3 = 12
+    FONZ_VOLTS3_DATA = 13
+    FONZ_GET_VOLTS4 = 14
+    FONZ_VOLTS4_DATA = 15
+    FONZ_GET_VOLTS5 = 16
+    FONZ_VOLTS5_DATA = 17
+    FONZ_GET_VOLTS6 = 18
+    FONZ_VOLTS6_DATA = 19
+    FONZ_GET_VOLTS7 = 20
+    FONZ_VOLTS7_DATA = 21
+    FONZ_GET_VOLTS8 = 22
+    FONZ_VOLTS8_DATA = 23
+
+    FONZ_GET_CURR1 = 24
+    FONZ_CURR1_DATA = 25
+    FONZ_GET_CURR2 = 26
+    FONZ_CURR2_DATA = 27
+    FONZ_GET_CURR3 = 28
+    FONZ_CURR3_DATA = 29
+    FONZ_GET_CURR4 = 30
+    FONZ_CURR4_DATA = 31
+    FONZ_GET_CURR5 = 32
+    FONZ_CURR5_DATA = 33
+    FONZ_GET_CURR6 = 34
+    FONZ_CURR6_DATA = 35
+    FONZ_GET_CURR7 = 36
+    FONZ_CURR7_DATA = 37
+    FONZ_GET_CURR8 = 38
+    FONZ_CURR8_DATA = 39
+
+    FONZ_GET_ALARMS = 40
+    FONZ_ALARM_RAISE = 41
+
+    FONZ_GET_OTTORST = 42
+    FONZ_OTTORST_DATA = 43
+    FONZ_GET_MISSION = 44
+    FONZ_MISSION_DATA = 45
+    FONZ_GET_COMPASS = 46
+    FONZ_COMPASS_DATA = 47
+    FONZ_GET_TWA = 48
+    FONZ_TWA_DATA = 49
+    FONZ_GET_RUDDER = 50
+    FONZ_RUDDER_DATA = 51
+    FONZ_GET_SAIL = 52
+    FONZ_SAIL_DATA = 53
+    FONZ_GET_PDOWN = 54
+    FONZ_PDOWN_DATA = 55
+    FONZ_GET_NAVLIGHT = 56
+    FONZ_NAVLIGHT_DATA = 57
+    FONZ_GET_BUZZER = 58
+    FONZ_BUZZER_DATA = 59
+
+    FONZ_GET_EEADDR = 60
+    FONZ_SET_EEADDR = 61
+    FONZ_GET_EEDATA = 62
+    FONZ_SET_EEDATA = 63
+
+    MESSAGES = [
+      "Ping", "Magic Word",
+      "ACK", "??",
+      "Get Time (Lo)", "Time Data (Lo)",
+      "Get Time (Hi)", "Time Data (Hi)",
+      "Get Voltage1", "Voltage1 Data",
+      "Get Voltage2", "Voltage2 Data",
+      "Get Voltage3", "Voltage3 Data",
+      "Get Voltage4", "Voltage4 Data",
+      "Get Voltage5", "Voltage5 Data",
+      "Get Voltage6", "Voltage6 Data",
+      "Get Voltage7", "Voltage7 Data",
+      "Get Voltage8", "Voltage8 Data",
+      "Get Current1", "Current1 Data",
+      "Get Current2", "Current2 Data",
+      "Get Current3", "Current3 Data",
+      "Get Current4", "Current4 Data",
+      "Get Current5", "Current5 Data",
+      "Get Current6", "Current6 Data",
+      "Get Current7", "Current7 Data",
+      "Get Current8", "Current8 Data",
+      "Get Alarms", "Alarm Raised!",
+      "Get Otto Reset", "Otto Reset Status",
+      "Get Mission", "Mission Data",
+      "Get Compass", "Compass Data",
+      "Get TWA", "TWA Data",
+      "Get Rudder Position", "Rudder Position Data",
+      "Get Sail Trim", "Sail Trim Data",
+      "Get Power Down", "Time to Power Down",
+      "Get Nav Light", "Nav Light Status",
+      "Get Buzzer", "Buzzer Status",
+      "Get EEPROM Address", "Set EEPROM Address",
+      "Get EEPROM Data", "Set EEPROM Data"
+    ].freeze
+
+    def initialize
+      @count = 0
+      @last_report = nil
+      @time = Array.new(32, Time.at(0))
+      super
+    end
+
+    #
+    # Convert a command code into a string.
+    def name(code)
+      (code < MESSAGES.count) ? MESSAGES[code] : nil
+    end
+
+    #
+    # Send a command to the microcontroller
+    def send_command(cmd, arg = nil)
+      puts "Send command #{cmd} (#{name(cmd)})"
+      puts "Arg is #{arg}" if arg
+      return 0
+    end
+  end
+end

data/lib/sgs/gps.rb

@@ -0,0 +1,53 @@
+#
+# Copyright (c) 2013, Kalopa Research.  All rights reserved.  This is free
+# software; you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation;
+# either version 2, or (at your option) any later version.
+#
+# It is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this product; see the file COPYING.  If not, write to the Free
+# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# THIS SOFTWARE IS PROVIDED BY KALOPA RESEARCH "AS IS" AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL KALOPA RESEARCH BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+module SGS
+  class GPS < RedisBase
+    attr_accessor :time, :location, :sog, :cmg, :magvar
+
+    def initialize(lat = nil, long = nil)
+      @time = Time.new(2000, 1, 1)
+      @location = Location.new(lat, long)
+      @sog = 0.0
+      @cmg = 0.0
+      @magvar = nil
+      @valid = false
+      super()
+    end
+
+    #
+    # Set the validity
+    def is_valid
+      @valid = true
+    end
+
+    #
+    # Is the GPS data valid?
+    def valid?
+      @valid == true
+    end
+  end
+end