farmbot-serial 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61087c538ee886dd6030ebb713f7463f912017d3
-  data.tar.gz: 84166a472181c9dad33a0f4a6477a7af6ee700d3
+  metadata.gz: 36f578bd91bd95febe44ce8f75b1590d668cbf99
+  data.tar.gz: e5cdea88aa5cab14e18e939af4628df061b4ec24
 SHA512:
-  metadata.gz: fdbcadb1607ee0cc2d0146f860d82129a6417c415c98819ef6abaab2c71076e7031f0afec753ce09c815f53bbde591e1e1ead1c623260e5e8d243093cdb4d79f
-  data.tar.gz: f154ffb8c945c40ae88e7976a6dfe51bb2eca1fdf2316547d9a55b1f10ad4d7b7bf801b830cc3464b7b154f0e173cbaf51ec3dbea4e7b6b64ffe4ff5ea89fc82
+  metadata.gz: 6c0365da760d44e89efedfb3e2ea6355895fc9158a6b894671a289283dbd3dec851c45aafffce5ee092f8a2de080ef687aa655c464a7b8b382d4edcf98214ecb
+  data.tar.gz: d88848b219d0dac50f3693fc2944b88d04ffa6a3ce04405fd4d2d1ee0f5b0dd97a8a495b94c050559d7f7da110307d668f48e7edf7d9392fd3c8bea9421d1698

data/README.md

@@ -1,3 +1,9 @@
+# STOP! You might not need this.
+
+`farmbot-serial` is a component used by the [Farmbot Raspberry Pi](https://github.com/FarmBot/farmbot-raspberry-pi-controller). If you are just trying to install a FarmBot, you do not need to use this. This component will be auto installed when you install the [Raspberry Pi Controller](https://github.com/FarmBot/farmbot-raspberry-pi-controller).
+
+If you are a developer looking to work directly with the FarmBot serial interface, you're in the right place.
+
 # Farmbot-Serial
 
 A ruby gem for controlling Farmbot via serial line with EventMachine.

data/lib/arduino.rb

@@ -4,8 +4,9 @@ require_relative 'arduino/incoming_handler'
 require_relative 'arduino/outgoing_handler'
 require_relative 'arduino/event_machine'
 require_relative 'arduino/status'
-# Communicate with the arduino using a serial interface
 module FB
+  # Software abstraction layer for the Arduino's serial interface. Translates
+  # Ruby method calls into serial commands.
   class Arduino
     Position = Struct.new(:x, :y, :z)
 

data/lib/arduino/incoming_handler.rb

@@ -1,5 +1,5 @@
 module FB
-  # Handles Gcode that moves from the Arduino to the Pi (Arduino -> Pi).
+  # Handles Gcode that was sent by the ARDUINO to the RASPBERRY PI.
   class IncomingHandler
     attr_reader :bot
 

data/lib/arduino/outgoing_handler.rb

@@ -1,6 +1,6 @@
 module FB
-  # Responsible for writing to the serial line. Sends Gcode from the pi to the
-  # arduino. (Pi -> Arduino)
+  # Writes GCode to the serial line. Creates messages the travel from the PI to
+  # the ARDUINO.
   class OutgoingHandler
     attr_reader :bot
 

data/lib/arduino/status.rb

@@ -1,5 +1,8 @@
 require 'ostruct'
 module FB
+  # A status register that caches the state of the Arduino into a struct. Also
+  # broadcasts changes that can be hooked into via the onchange() event.
+  # bot.status[:X] # => Returns bot X coordinate.
   class Status
     # Map of informational status and default values for status within Arduino.
     DEFAULT_INFO = {X: 0, Y: 0, Z: 0, S: 10, BUSY: 1, LAST: 'none', PINS: {}}

data/lib/default_serial_port.rb

@@ -1,8 +1,9 @@
 require 'serialport'
 
-# This object creates a Serial IO with sane defaults, since most FarmBot setups
-# follow the same serial configuration setup. You can build your own SerialPort
-# object also, if that's what you need.
+# This object creates a Serial IO Object with sane defaults, since most FarmBot
+# setups follow the same serial configuration setup. You can build your own
+# SerialPort object also, if that's what you need. DefaultSerialPort is just a
+# suggestion, rather than the only option. Any serial connection will work.
 module FB
   class DefaultSerialPort < SerialPort
     COM_PORT = '/dev/ttyACM0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-serial
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Tim Evers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="