Add support for CTT/Cornell tags

Author: tve

src/cornelltagxcvr.js

@@ -0,0 +1,86 @@
+/*
+
+  operate a Cornell (Gabrielson & Winkler) tag transceiver, in
+  receive-only mode; also works for a CTT LifeTag Motus Adapter
+
+  This object represents a plugged-in CornellTagXCVR.  As soon as it
+  is created, it begins recording tag detections.  The device reports detections
+  via an FTDI FT232 USB serial adapter running at 115200 bps raw.  Tag
+  detections are printed as XXXXXXXX\r\n where X are hex digits.
+  The CTT LifeTag Motus Adapter reports detections as XXXXXXXX,RSSI\r\n.
+
+  This module watches for such strings, and emits gotTag events of the form:
+
+      T[0-9]{1,2},<TS>,<ID>,<RSSI>\n
+
+  where the number after 'T' is the USB port #, <TS> is the ISO timestamp,
+  <ID> is the bare 8-hex digit tag ID, and <RSSI> is the raw RSSI value.
+
+*/
+
+const readline = require('readline');
+
+CornellTagXCVR = function(matron, dev) {
+
+    this.matron = matron;
+    this.dev = dev;
+    this.rs = null;   // readable stream to serial device 
+    this.rl = null; // readline interface for readstream
+    this.rate = 115200; // assumed fixed serial rate (bits per second)
+
+    // callback closures
+    this.this_devRemoved             = this.devRemoved.bind(this);
+    this.this_gotTag                 = this.gotTag.bind(this);
+
+    this.matron.on("devRemoved", this.this_devRemoved);
+
+    this.init();
+};
+
+
+CornellTagXCVR.prototype.devRemoved = function(dev) {
+    if (dev.path != this.dev.path)
+        return;
+    if (this.rs) {
+        this.rs.close();
+        this.rs = null;
+    }
+};
+
+CornellTagXCVR.prototype.init = function() {
+    // open the device fd
+
+    try {
+        this.rs = Fs.createReadStream(this.dev.path);
+        this.rl = readline.createInterface({
+            input: this.rs,
+            terminal: false 
+        });
+        this.rl.on("line", this.this_gotTag);
+        //console.log('Starting read stream at', this.dev.path);
+    } catch (e) {
+        // not sure what to do here
+        console.log("Failed to open CornellTagXCVR at " + this.dev.path + "\n");
+        console.log(e);
+    }
+};
+
+CornellTagXCVR.prototype.gotTag = function(record) {
+    //console.log("Got CTT line: " + record)
+    var vals = record.split(',')
+    var tag = vals.shift(); // Tag ID should be the first record
+    // emit all detections at once
+    if (tag) {
+        var now = new Date();
+        var now_secs = now.getTime() / 1000;
+
+        var rssi = vals.shift(); // RSSI should be the second record
+        var lifetag_record = ['T'+this.dev.attr.port, now.toISOString(), tag, rssi].join(',')  // build the values to generate a CSV row
+        this.matron.emit('gotTag', lifetag_record+'\n');
+        // an event can be emitted here for vahdata if interested in streaming to 'all' files
+        // this.matron.emit('vahData', lifetag_record+'\n');
+        LifetagOut.write(lifetag_record+'\n');
+    }
+};
+
+exports.CornellTagXCVR = CornellTagXCVR;

src/main.js

@@ -43,19 +43,6 @@ Machine = require('./machine.js');
 Matron = require('./matron.js');
 TheMatron = new Matron.Matron();
 
-// Figure out the tag database file location, iterating through a number of locations
-tdb_locs = [
-    "/data/config/SG_tag_database.sqlite",  // new preferred location
-    "/data/config/SG_tag_database.csv",
-]
-TheMatron.tagDBFile = tdb_locs[tdb_locs.length-1]  // default/fall-back location
-for (const f of tdb_locs) {
-    if (Fs.existsSync(f)) {
-        TheMatron.tagDBFile = f
-        break
-    }
-}
-
 // Load singleton objects
 GPS           = new (require('./gps.js').GPS)       (TheMatron);
 HubMan        = new (require('./hubman.js').HubMan) (TheMatron, "/dev/sensorgnome");
@@ -66,44 +53,52 @@ Schedule      = require('./schedule.js');
 Sensor        = require('./sensor.js');
 USBAudio      = require("./usbaudio.js");
 RTLSDR        = require("./rtlsdr.js");
+CornellTagXCVR= require("./cornelltagxcvr.js");
 
 //WavMaker      = require('./wavmaker.js');
 
 // Figure out the location of the deployment.txt file
-Deployment = new (require("./deployment.js").Deployment) (
- [
-     "/data/config/deployment.txt",  // new preferred location
- ]);
+Deployment = new (require("./deployment.js").Deployment)(
+    [
+        "/data/config/deployment.txt",  // new preferred location
+    ]);
 
 // replace "-" with "_" in deployment short label, so filenames
 // use "-" only for delimiting fields
 
 Deployment.shortLabel = Deployment.shortLabel.replace(/-/g,"_");
 
-TagFinder     = new (require('./tagfinder.js').TagFinder) (TheMatron,
-                                                           "/usr/bin/find_tags_unifile",
-                                                           TheMatron.tagDBFile,
-                                                           Deployment.module_options.find_tags.params
-                                                          );
+TagFinder = new (require('./tagfinder.js').TagFinder)(
+    TheMatron,
+    "/usr/bin/find_tags_unifile",
+    [
+        "/data/config/SG_tag_database.sqlite",  // new preferred location
+        "/data/config/SG_tag_database.csv"],
+    Deployment.module_options.find_tags.params
+);
 
 DataSaver     = new (require('./datasaver.js').DataSaver) (TheMatron);
 
 SafeStream    = require('./safestream.js').SafeStream;
 
 AllOut = new SafeStream(TheMatron, "all", ".txt", 1000000, 3600);
 
+LifetagOut = new SafeStream(TheMatron, "ctt", ".txt", 1000000, 3600);
+
 Uploader = new (require('./uploader.js').Uploader) (TheMatron);
 
 Relay = new (require('./relay.js').Relay) (TheMatron, 59000);
 
+
 var clockNotSet = true;
 
 function do_nothing(err, stdout, stderr) {
 };
 
 TheMatron.on("gotGPSFix", function(fix) {
     AllOut.write("G," + fix.time + "," + fix.lat + "," + fix.lon + "," + fix.alt + "\n" );
-//ugly hack to set date from gps if gps has fix but system clock not set
+    LifetagOut.write("G," + fix.time + "," + fix.lat + "," + fix.lon + "," + fix.alt + "\n" );
+    //ugly hack to set date from gps if gps has fix but system clock not set
     if (clockNotSet && (new Date()).getFullYear() < 2013) {
         console.log("Trying to set time to " + fix.time + "\n");
         ChildProcess.exec("date --utc -s @" + fix.time, do_nothing);

src/matron.js

@@ -24,16 +24,22 @@ Matron = function() {
 Util.inherits(Matron, Events.EventEmitter);
 
 Matron.prototype.devAdded = function(dev) {
-//DEBUG: console.log("Got devAdded " + JSON.stringify(dev) + "\n");
+    console.log("New device found: " + dev.path);
+
     var devPlan = Deployment.lookup(dev.attr.port, dev.attr.type);
     if (devPlan) {
-//DEBUG: console.log("Got plan " + JSON.stringify(devPlan));
+        //console.log("Got plan " + JSON.stringify(devPlan));
         this.devices[dev.attr.port] = Sensor.getSensor(this, dev, devPlan);
     }
+
+    // for CornellTagXCVR, we don't require or use a plan
+    if (dev.attr.type == "CornellTagXCVR") {
+        this.devices[dev.attr.port] = new CornellTagXCVR.CornellTagXCVR(this, dev, null);
+    }
 };
 
 Matron.prototype.devRemoved = function(dev) {
-//DEBUG: console.log("Got devRemoved " + JSON.stringify(dev) + "\n");
+    console.log("Device removed: " + dev.path);
     if (this.devices[dev.attr.port]) {
         this.devices[dev.attr.port] = null;
     };

src/public/index.html

@@ -165,16 +165,16 @@ <h3> What I'm doing now:</h3>
       <div id="softwareupdate">
         <b> SensorGnome Software Update</b>
         <br>
-        <p><b>Not currently functioning...</b></p>
-        <form id="updateUploadForm" action="/upload_software_update", method="POST", enctype="multipart/form-data">
+        <p><i>Not currently functional...</i></p>
+        <!-- form id="updateUploadForm" action="/upload_software_update", method="POST", enctype="multipart/form-data">
           <p> Please browse to the update file (called <i>TBD...</i>):
             <input type="file" name="update_archive" size=60></input>
             <br>
             <br>
             <input type="submit" value="Upload this software update to your SensorGnome..."></input>
             <br>
             <span id="softwareUpdateResults"></span>
-        </form>
+        </form -->
         <br>
       </div>
       <div id="rebootSystem">

src/public/javascripts/sensorgnome.js

@@ -146,16 +146,42 @@ function onNewVahData (data) {
         elt[0].scrollTop = top;
 };
 
-function onGotTag (data) {
-    tagBuf = tagBuf.concat(data.split(/\n/));
-    var line="";
+function onGotLifetag(data) {
+    alert('got lifetag '+data);
+}
+    
+function checkLifeTag(data) {
+    var vals = data.split(',');
+    if (vals.length == 4) {
+        return {
+            port: vals[0],
+            received_at: vals[1].replace(/[ZT]/g, " "),
+            tag: vals[2],
+            rssi: parseInt(vals[3])
+        }
+    }
+    return null;
+}
+
+function onGotTag(data, lifetag = false) {
     var elt = $("#taglog");
     var top = elt[0].scrollTop;
-    while (tagBuf.length) {
-        var hit = tagBuf.shift().split(/,/);
-        if (hit.length == 13) {
-            line += (new Date(parseFloat(hit[1]) * 1000)).toISOString().replace(/[ZT]/g," ").substr(11);
-            line += "ant " + hit[0] + " " + hit[2] + " + " + hit[3] + " kHz " + hit[5] + " / " + hit[7] + " dB\n";
+    var line = "";
+
+    var lifetag = checkLifeTag(data);
+    if (lifetag) {
+        line = lifetag.received_at.replace(/^\S+\s/, "") + 'port ' + lifetag.port.substr(1) +
+            ' ' + lifetag.tag + '@434Mhz ' + lifetag.rssi + 'dB\n';
+    } else {
+        tagBuf = tagBuf.concat(data.split(/\n/));
+        while (tagBuf.length) {
+            var hit = tagBuf.shift().split(/,/);
+            if (hit.length == 13) {
+                let d = new Date(parseFloat(hit[1]) * 1000);
+                line += d.toISOString().replace(/(^.*T)|Z/g, "") +
+                    " ant  " + hit[0] + " " + hit[2] + " + " + hit[3] + "kHz " + 
+                    hit[5] + "/" + hit[7] + "dB\n";
+            }
         }
     }
     elt.append(line);
@@ -277,6 +303,11 @@ function onDevinfo (data) {
             txt = "USB audio device: " + d["name"];
             txt += '<span id="raw_audio_span' + slot + '"><audio id="raw_audio' + slot + '" src="/raw_audio?dev=' + slot + '&fm=0&random=' + Math.random() +'" preload="none"></audio></span> <button id="raw_audio_button' + slot + '" type="button" onclick="listenToRaw(' + slot + ')">Listen</button>';
             break;
+
+        case "CornellTagXCVR":
+            txt = devList[slot]["name"];
+            break;
+            
         default:
             txt = "unknown";
         }

src/tagfinder.js

@@ -3,14 +3,15 @@
   emitting gotTag messages.
 */
 
-function TagFinder(matron, prog, tagFile, params) {
-    this.matron = matron;
-    this.prog = prog;
-    this.tagFile = tagFile;
-    this.params = params || [];
-    this.child = null;
-    this.quitting = false;
-    this.inDieHandler = false;
+function TagFinder(matron, prog, tagFiles, params) {
+    this.matron             = matron;
+    this.prog               = prog;
+    this.tagFiles           = tagFiles;
+    this.params             = params || [];
+    this.noTagFile          = false; // used to print no-tag-file error once
+    this.child              = null;
+    this.quitting           = false;
+    this.inDieHandler       = false;
     this.this_spawnChild    = this.spawnChild.bind(this);
     this.this_quit          = this.quit.bind(this);
     this.this_childDied     = this.childDied.bind(this);
@@ -53,7 +54,29 @@ TagFinder.prototype.spawnChild = function() {
     if (this.quitting)
         return;
 
-    var p = this.params.concat("-c", "8", this.tagFile);
+    // see whether we can find a tag file
+    this.matron.tagDBFile = null;
+    for (let tf of this.tagFiles) {
+        if (Fs.existsSync(tf)) {
+            this.matron.tagDBFile = tf;
+            break;
+        }
+    }
+    
+    // if we have no tag file, print an error once, and then sleep for a bit a retry
+    if (! this.matron.tagDBFile) {
+        if (! this.noTagFile) {
+            console.log("No tag database for tag finder, looking at " + this.tagFiles.join(", "));
+            this.noTagFile = true;
+        }
+
+        setTimeout(this.this_spawnChild, 10000);
+        return;
+    }
+    this.noTagFile = false;
+
+    // launch the tag finder process
+    var p = this.params.concat("-c", "8", this.matron.tagDBFile);
     console.log("Starting ", this.prog, " ", p.join(" "));
     var child = ChildProcess.spawn(this.prog, p)
         .on("exit", this.this_childDied)

src/webserver.js

@@ -179,15 +179,18 @@ WebServer.prototype.pushPlan = function () {
 };
 
 WebServer.prototype.requestedTagDB = function() {
-    if (this.matron.tagDBFile.match(/sqlite$/))
+    if (! this.matron.tagDBFile)
+        this.this_pushTagDB("No tag database file found");
+    else if (this.matron.tagDBFile.match(/sqlite$/))
         ChildProcess.exec("/usr/bin/sqlite3 " + this.matron.tagDBFile +  " 'select proj,id,tagFreq,dfreq-1000*(tagFreq-fcdFreq) as dfreq,bi from tags order by proj,tagFreq,id,bi'", this.this_pushTagDB);
     else
         Fs.readFile(this.matron.tagDBFile, this.this_pushTagDB);
 };
 
 WebServer.prototype.pushTagDB = function(err, data) {
     if (this.sock) {
-        var obj = {err: err, file:Path.basename(this.matron.tagDBFile), data:data ? data.toString(): "ERROR"};
+        let f = this.matron.tagDBFile ? Path.basename(this.matron.tagDBFile) : "";
+        var obj = {err: err, file: f, data:data ? data.toString(): "ERROR"};
         this.sock.emit('tagDB', obj);
     }
 };
@@ -267,7 +270,7 @@ WebServer.prototype.sendMachineInfo = function () {
 };
 
 WebServer.prototype.clientDisconnected = function () {
-    console.log("Got to client disconnected.\n");
+    console.log("WS client disconnected");
     if (this.sock) {
         this.matron.removeListener('gotGPSFix'    , this.this_pushGPSFix);
         this.matron.removeListener('gotTag'       , this.this_pushTag);
@@ -302,7 +305,7 @@ WebServer.prototype.setParamError = function (data) {
 // Web Sockets
 
 WebServer.prototype.handleWebConnection = function (socket) {
-    console.log("host: received connection to push socket");
+    console.log("WS client connected", socket.handshake.address);
     this.sock = socket;
     socket.on('disconnect'    , this.this_clientDisconnected);
     socket.on('error'         , this.this_clientDisconnected);