nmea.tcl

Go to the documentation of this file.

/*  nmea.tcl --*/
/* */
/*  NMEA protocol implementation*/
/* */
/*  Copyright (c) 2006-2007 Aaron Faupell*/
/* */
/*  RCS: @(#) $Id: nmea.tcl,v 1.3 2007/08/20 21:55:27 andreas_kupries Exp $*/

package require Tcl 8.2
package provide nmea 0.1.1

namespace ::nmea {
     ::nmea = ::nmea(checksum) 1
     ::nmea = ::nmea(log) ""
}

ret  ::nmea::open_port (type port , optional speed =4800) {
    variable nmea
    set nmea(fh) [open $port]
    fconfigure $nmea(fh) -mode $speed,n,8,1 -handshake xonxoff -buffering line -translation crlf
    fileevent $nmea(fh) readable [list ::nmea::read_port $nmea(fh)]
    return 1
}

ret  ::nmea::open_file (type file , type rate) {
    variable nmea
    set nmea(fh) [open $file]
    set nmea(rate) $rate
    fconfigure $nmea(fh) -buffering line -blocking 0 -translation auto
    if {$rate > 0} {
        after $rate [list ::nmea::read_file $nmea(fh)]
    }
}

ret  ::nmea::configure_port (type settings) {
    variable nmea
    fconfigure $nmea(fh) -mode $settings
}

ret  ::nmea::close_port () {
    variable nmea
    catch {close $nmea(fh)}
}

ret  ::nmea::close_file () {
    variable nmea
    catch {close $nmea(fh)}
}

ret  ::nmea::read_port (type f) {
    set line [gets $f]
    if {$::nmea::nmea(log) != ""} {
        puts $::nmea::nmea(log) $line
    }
    ::nmea::parse_nmea $line
}

ret  ::nmea::read_file (type f) {
    variable nmea
    if {![eof $f]} {
        set line [gets $f]
        if {[string match {$*} $line]} {
            ::nmea::parse_nmea $line
        } else {
            ::nmea::parse_nmea \$$line
        }
    }
    after $nmea(rate) [list ::nmea::read_file $f]
}

ret  ::nmea::do_line () {
    variable nmea
    if {![eof $nmea(fh)]} {
        set line [gets $nmea(fh)]
        if {[string match {$*} $line]} {
            ::nmea::parse_nmea $line
        } else {
            ::nmea::parse_nmea \$$line
        }
    }
}

ret  ::nmea::log (type file) {
    variable nmea
    if {$file != ""} {
        if {$nmea(log) != ""} { error "already logging to a file" }
        set nmea(log) [open $file a]
    } else {
        catch {close $nmea(log)}
        set nmea(log) ""
    }
}

ret  ::nmea::parse_nmea (type line) {
    set line [split $line \$*]
    set cksum [lindex $line 2]
    set line [lindex $line 1]
    if {$cksum == "" || !$::nmea::nmea(checksum) || [checksum $line] == $cksum} {
        set line [split $line ,]
        set sentence [lindex $line 0]
        set line [lrange $line 1 end]
        if {[info commands ::nmea::$sentence] != ""} {
            $sentence $line
        }
    }
}

ret  ::nmea::checksum (type line) {
    set sum 0
    binary scan $line c* line
    foreach char $line {
        set sum [expr {$sum ^ ($char % 128)}]
    }
    return [format %02X [expr {$sum % 256}]]
}

ret  ::nmea::write (type type , type args) {
    variable nmea
    set data $type,[join $args ,]
    puts $nmea(fh) \$$data*[checksum $data]
}