cycle_analyst_logger 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e885a854ee604b2fcc3de0f076020ad88e30972
-  data.tar.gz: 938b370409f465698bbd7f2bde1706c4280b13b8
+  metadata.gz: c3011f180df601db59efd523a1ee9ccb6ffd6521
+  data.tar.gz: f53a937549e43c562ad8c0e1a594235f9946cf83
 SHA512:
-  metadata.gz: ebbdd12998582bdce46f83954b3972efd2b94279d2e54386723cd75eb3e73d034b4a0a81ef59c75f775284d15242b09b7cc01678010c163811b280b4294e7eb9
-  data.tar.gz: d63f206c042bce110754866f846cd2b68b306741082bbcdca8eb06650a6ec8bc8ce983e069cc455fccfca97ab93f31c64b2eb9362c6e6c0389d09718460e72f7
+  metadata.gz: 96c66ff2178ae54788ab15ec4221fe4fda695b777426316f1c80d7c592f1c8a9f8a5cb90595e0062c7d181239c537f0ffd5f6690dc94c7e6737cfef5cc13002f
+  data.tar.gz: 69cc29521879ff250579f6b1ff3e9db483c3d550d5686bf4b73a4a40443009953f936285ce9d5d4c79188ede57b3b453264ada57d1070e5ccf89a1f911f58578

data/README.rdoc

@@ -3,28 +3,32 @@
 {<img src="https://badge.fury.io/rb/cycle_analyst_logger.svg" alt="Gem Version" />}[https://badge.fury.io/rb/cycle_analyst_logger]
 
 == NAME
-    cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner
+    cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner and GPS
 
 == SYNOPSIS
     cycle_analyst_logger [global options] command [command options] [arguments...]
     cycle_analyst_logger [global options] log [tty] [baudrate] [enable_phaserunner] [tty] [baudrate]
-    cycle_analyst_logger [global options] location_from_gmx gpx_filename log_filename [output_filename]
+
+== Notes
+Only tested with {Navspark-BD GPS}[http://navspark.mybigcommerce.com/navspark-bd-arduino-compatible-development-board-with-gps-beidou/]
 
 == GLOBAL OPTIONS
-    -t, --tty_ca=arg         - Cycle Analyst Serial (USB) device (default: /dev/ttyUSB1)
-    -b, --baud_ca=arg        - Cycle Analyst Serial port baudrate (default: 9600)
-    --enable_phaserunner=arg - Get PhaseRunner Logs also (default: true)
-    --tty_pr=arg             - Phaserunner Serial (USB) device (default: /dev/ttyUSB0)
-    --baud_pr=arg            - Phaserunner Serial port baudrate (default: 115200)
-    -l, --loop_count=arg     - How many lines to read (default: forever)
-    --version                - Display the program version
-    -q, --[no-]quiet         - Do not output to stdout
-    --help                   - Show this message
+    -t, --tty_ca=arg          - Cycle Analyst Serial (USB) device (default: /dev/cycle_analyst)
+    -b, --baud_ca=arg         - Cycle Analyst Serial port baudrate (default: 9600)
+    --tty_pr=arg              - Phaserunner Serial (USB) device (default: /dev/phaserunner)
+    --baud_pr=arg             - Phaserunner Serial port baudrate (default: 115200)
+    --tty_gps=arg             - Gps Serial (USB) device (default: /dev/gps)
+    --baud_gps=arg            - Gps Serial port baudrate (default: 115200)
+    -l, --loop_count=arg      - How many lines to read (default: forever)
+    --version                 - Display the program version
+    --[no-]enable_phaserunner - Get PhaseRunner Logs also (default: enabled)
+    --[no-]enable_gps         - Get Gps Logs also (default: enabled)
+    -q, --[no-]quiet          - Do not output to stdout
+    --help                    - Show this message
 
 == COMMANDS
     help - Shows a list of commands or help for one command
     log  - Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
-    location_from_gmx, loc - Merge geo info from GMX file and log lines from log file
 
 === Attributes that are Logged
 
@@ -58,7 +62,71 @@
 * Phaserunner Last Fault ()
 * Phaserunner Warnings ()
 * Phaserunner Motor Input Power (W)
+* GPS Time
+* GPS Latitude
+* GPS Longitude
+* GPS Altitude
+* GPS Speed
+* GPS Fix Quality
+* GPS Satellites
+* GPS Geoid Height
+* GPS Horizontal Dilution
+* GPS FAA Mode
+
+== Udev set up
+
+A sampe udev rules file is in +resources/99-cycle_analyst.rules+. It is based on
+the information from {Persistent names for usb-serial
+devices}[http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/]
+
+This one assumes we have the TTL to USB Cable based on the FTDI chipset like the
+{USB Cables from Grin Tech}[http://www.ebikes.ca/ca-usb.html] We have one for
+the Cycle Analyst (CA) and one for the Phaserunner. If you always use the same
+cable with the CA and the other cable always for the Phaserunner (Label them).
+Then you can get away with using the serial numbers that the UDEV system sees to
+automatically link whatever USB port the cable is plugged into to the right
++/dev+ name.
+
+The Navspark-BD GPS I used has a built in PL2303 chipset and doesn't seem to
+have a serial number like the FTDI chipsets does. So the setup assumes there is
+only one PL2303 USB and its the GPS.
+
+== Systemd startup
+
+There is a working systemd service unit file
++resources/cycle_analyst_logger.service+. You can copy it into
++/lib/systemd/system+ and do a
+
++systemctl daemon-reload+ to load it into systemd
+
+* If you want it to start when the system is booted say:
+
++systemctl enable cycle_analyst_logger.service+
+
+* To disable:
+
++systemctl disable cycle_analyst_logger.service+
+
+* To start it manually (have to do this also the first time you do an enable and
+  want it to run then):
+
++systemctl start cycle_analyst_logger.service+
+
+* You can check the status:
+
++systemctl status cycle_analyst_logger.service+
+
+* To see the logs:
+
++journalctl -u cycle_analyst_logger.service+
+
+This file assumed that rvm was installed in my home directory and an rvm wrapper
+was created so it the service unit file could just exec it. I am currently using
+Ruby 2.4.1.
+
+The command used to create the wrapper was run as my normal user:
 
++rvm alias create cycle_analyst_logger 2.4.1+
 
 == License and Copyright
 

data/cycle_analyst_logger.rdoc

@@ -1,6 +1,6 @@
 == cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner
 
-v0.2.4
+v0.3.3
 
 === Global Options
 === -b|--baud_ca arg
@@ -10,18 +10,18 @@ Cycle Analyst Serial port baudrate
 [Default Value] 9600
 
 
-=== --baud_pr arg
+=== --baud_gps arg
 
-Phaserunner Serial port baudrate
+Gps Serial port baudrate
 
 [Default Value] 115200
 
 
-=== --enable_phaserunner arg
+=== --baud_pr arg
 
-Get PhaseRunner Logs also
+Phaserunner Serial port baudrate
 
-[Default Value] true
+[Default Value] 115200
 
 
 === -l|--loop_count arg
@@ -35,14 +35,31 @@ How many lines to read
 
 Cycle Analyst Serial (USB) device
 
-[Default Value] /dev/ttyUSB1
+[Default Value] /dev/cycle_analyst
+
+
+=== --tty_gps arg
+
+Gps Serial (USB) device
+
+[Default Value] /dev/gps
 
 
 === --tty_pr arg
 
 Phaserunner Serial (USB) device
 
-[Default Value] /dev/ttyUSB0
+[Default Value] /dev/phaserunner
+
+
+=== --[no-]enable_gps
+Get Gps Logs also
+
+
+
+=== --[no-]enable_phaserunner
+Get PhaseRunner Logs also
+
 
 
 === --help
@@ -71,11 +88,13 @@ List commands one per line, to assist with shell completion
 
 
 
-==== Command: <tt>location_from_gmx|loc </tt>
-Merge geo info from GMX file and log lines from log file
+==== Command: <tt>log </tt>
+Log the Cycle Analyst and optionally GPS and Phaserunner to a file
 
 
-==== Command: <tt>log </tt>
-Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
+===== Options
+===== --[no-]disable_nmea_out
+Disable writing raw nmea to its own file
+
 
 

data/lib/cycle_analyst_logger/cli.rb

@@ -25,7 +25,7 @@ module CycleAnalystLogger
       sort_help :manually
 
       desc 'Cycle Analyst Serial (USB) device'
-      default_value '/dev/ttyUSB1'
+      default_value '/dev/cycle_analyst'
       arg 'tty', :optional
       flag [:t, :tty_ca]
 
@@ -39,7 +39,7 @@ module CycleAnalystLogger
       switch [:enable_phaserunner]
 
       desc 'Phaserunner Serial (USB) device'
-      default_value '/dev/ttyUSB0'
+      default_value '/dev/phaserunner'
       arg 'tty', :optional
       flag [:tty_pr]
 
@@ -53,7 +53,7 @@ module CycleAnalystLogger
       switch [:enable_gps]
 
       desc 'Gps Serial (USB) device'
-      default_value '/dev/ttyUSB2'
+      default_value '/dev/gps'
       arg 'tty', :optional
       flag [:tty_gps]
 
@@ -80,21 +80,6 @@ module CycleAnalystLogger
         end
       end
 
-      desc 'Merge geo info from GMX file and log lines from log file'
-      arg :gpx_filename
-      arg :log_filename
-      arg :output_filename, :optional
-      command [:location_from_gmx, :loc]  do |location_from_gmx|
-        location_from_gmx.action do |global_options, options, args|
-          gpx_filename = args[0]
-          log_filename = args[1]
-          output_filename = args[2]
-
-          gpx = Gpx.new(gpx_filename)
-          gpx.merge_location(log_filename, output_filename)
-        end
-      end
-
       pre do |global,command,options,args|
         # Pre logic here
         # Return true to proceed; false to abort and not call the

data/lib/cycle_analyst_logger/gps.rb

@@ -5,7 +5,7 @@ module CycleAnalystLogger
 
   class Gps
     DEFAULTS = {
-      tty: '/dev/ttyUSB2',
+      tty: '/dev/gps',
       baudrate: 115200
     }
 

data/lib/cycle_analyst_logger/version.rb

@@ -1,3 +1,3 @@
 module CycleAnalystLogger
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 end

data/resources/99-cycle_analyst.rules

@@ -0,0 +1,3 @@
+SUBSYSTEM=="tty", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6015", ATTRS{serial}=="DB00KZ46", SYMLINK+="phaserunner"
+SUBSYSTEM=="tty", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6015", ATTRS{serial}=="DB00KLD2", SYMLINK+="cycle_analyst"
+SUBSYSTEM=="tty", ATTRS{idVendor}=="067b", ATTRS{idProduct}=="2303", SYMLINK+="gps"

data/resources/cycle_analyst_logger.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=starts cycle_analyst_logger
+After=network.target
+After=syslog.target
+
+[Service]
+WorkingDirectory=/home/rberger/work/trike/logs
+ExecStart=/home/rberger/.rvm/wrappers/ruby-2.4.1/cycle_analyst_logger -q log
+Restart=always
+RestartSec=30
+
+[Install]
+WantedBy=multi-user.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cycle_analyst_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Robert J. Berger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -216,6 +216,8 @@ files:
 - lib/cycle_analyst_logger/gps.rb
 - lib/cycle_analyst_logger/gpx.rb
 - lib/cycle_analyst_logger/version.rb
+- resources/99-cycle_analyst.rules
+- resources/cycle_analyst_logger.service
 - todo.txt
 homepage: https://github.com/rberger/cycle_analyst_logger
 licenses: