1nmea(n)                  NMEA protocol implementation                  nmea(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       nmea -
9

SYNOPSIS

11       package require Tcl  8.2
12
13       package require nmea  ?0.1?
14
15       ::nmea::open_port port ?speed?
16
17       ::nmea::open_file file rate
18
19       ::nmea::configure_port settings
20
21       ::nmea::close_port
22
23       ::nmea::close_file
24
25       ::nmea::do_line
26
27       ::nmea::log file
28
29       ::nmea::checksum data
30
31       ::nmea::write sentence data
32
33_________________________________________________________________
34

DESCRIPTION

36       This  package  provides  commands  to  read NMEA standard data from COM
37       ports or files.  The sentences  are  optionally  checksummed  and  then
38       passed  on to user defined procs for handling. To use a handler, create
39       a proc with the NMEA sentence name in the ::nmea namespace. For example
40       to  process  GPS  fix data use "proc ::nmea::GPGSA". The proc must take
41       one argument, which is a list of the data values.
42

COMMANDS

44       ::nmea::open_port port ?speed?
45              Open the specified COM port and read NMEA sentences when  avail‐
46              able. Port speed is set to 4800bps by default or to speed.
47
48       ::nmea::open_file file rate
49              Open  file  file  and  read NMEA sentences, one per line, at the
50              rate by rate in milliseconds.  The  file  format  may  omit  the
51              leading  $  and/or the checksum. If rate is <= 0 then lines will
52              only be processed when a call to do_line is made. The  rate  may
53              be adjusted by setting ::nmea::nmea(rate).
54
55       ::nmea::configure_port settings
56              Changes  the current port settings. settings has the same format
57              as fconfigure -mode.
58
59       ::nmea::close_port
60              Close the open port
61
62       ::nmea::close_file
63              Close the open file
64
65       ::nmea::do_line
66              If there is a currently open file, this command  will  read  and
67              process a single line from it.
68
69       ::nmea::log file
70              ] Starts or stops file logging. If a file name is specified then
71              all NMEA output will be logged to the file in  append  mode.  If
72              file is an empty string then any logging will be stopped.
73
74       ::nmea::checksum data
75              Returns the checksum of the supplied data
76
77       ::nmea::write sentence data
78              If  there  is a currently open port, this command will write the
79              specified sentence and data in proper NMEA checksummed format.
80

VARIABLES

82       ::nmea::checksum
83              A boolean value which determines whether incoming sentences  are
84              validated or not.
85
86       ::nmea::rate
87              When  reading from a file this sets the rate that lines are pro‐
88              cessed in milliseconds.
89

KEYWORDS

91       nmea
92

94       Copyright (c) 2006, Aaron Faupell <afaupell@users.sourceforge.net>
95
96
97
98
99nmea                                  0.1                              nmea(n)
Impressum