xref: /freebsd/contrib/ntp/include/trimble.h (revision fbbd9655e5107c68e4e0146ff22b73d7350475bc)
1 /*
2  * /src/NTP/ntp4-dev/include/trimble.h,v 4.6 2005/04/16 17:32:10 kardel RELEASE_20050508_A
3  *
4  * trimble.h,v 4.6 2005/04/16 17:32:10 kardel RELEASE_20050508_A
5  *
6  * $Created: Sun Aug  2 16:16:49 1998 $
7  *
8  * Copyright (c) 1998-2005 by Frank Kardel <kardel <AT> ntp.org>
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the author nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  */
35 #ifndef TRIMBLE_H
36 #define TRIMBLE_H
37 
38 /*
39  * Trimble packet command codes - commands being sent/received
40  * keep comments formatted as shown - they are used to generate
41  * translation tables
42  */
43 #define CMD_CCLROSC	0x1D	/* clear oscillator offset */
44 #define CMD_CCLRRST	0x1E	/* clear battery backup and RESET */
45 #define CMD_CVERSION	0x1F	/* return software version */
46 #define CMD_CALMANAC	0x20	/* almanac */
47 #define CMD_CCURTIME	0x21	/* current time */
48 #define CMD_CMODESEL	0x22	/* mode select (2-d, 3-D, auto) */
49 #define CMD_CINITPOS	0x23	/* initial position */
50 #define	CMD_CRECVPOS	0x24	/* receiver position fix mode */
51 #define CMD_CRESET	0x25	/* soft reset & selftest */
52 #define CMD_CRECVHEALTH	0x26	/* receiver health */
53 #define CMD_CSIGNALLV	0x27	/* signal levels */
54 #define CMD_CMESSAGE	0x28	/* GPS system message */
55 #define CMD_CALMAHEALTH	0x29	/* almanac healt page */
56 #define CMD_C2DALTITUDE	0x2A	/* altitude for 2-D mode */
57 #define CMD_CINITPOSLLA	0x2B	/* initial position LLA */
58 #define CMD_COPERPARAM	0x2C	/* operating parameters */
59 #define CMD_COSCOFFSET	0x2D	/* oscillator offset */
60 #define CMD_CSETGPSTIME	0x2E	/* set GPS time */
61 #define CMD_CUTCPARAM	0x2F	/* UTC parameters */
62 #define CMD_CACCPOSXYZ	0x31	/* accurate initial position (XYZ/ECEF) */
63 #define CMD_CACCPOS	0x32	/* accurate initial position */
64 #define CMD_CANALOGDIG	0x33	/* analog to digital */
65 #define CMD_CSAT1SAT	0x34	/* satellite for 1-Sat mode */
66 #define CMD_CIOOPTIONS	0x35	/* I/O options */
67 #define CMD_CVELOCAID	0x36	/* velocity aiding of acquisition */
68 #define CMD_CSTATLSTPOS	0x37	/* status and values of last pos. and vel. */
69 #define CMD_CLOADSSATDT	0x38	/* load satellite system data */
70 #define CMD_CSATDISABLE	0x39	/* satellite disable */
71 #define CMD_CLASTRAW	0x3A	/* last raw measurement */
72 #define CMD_CSTATSATEPH	0x3B	/* satellite ephemeris status */
73 #define CMD_CSTATTRACK	0x3C	/* tracking status */
74 #define CMD_CCHANADGPS	0x3D	/* configure channel A for differential GPS */
75 #define CMD_CADDITFIX	0x3E	/* additional fix data */
76 #define CMD_CDGPSFIXMD	0x62	/* set/request differential GPS position fix mode */
77 #define CMD_CDGPSCORR	0x65	/* differential correction status */
78 #define CMD_CPOSFILT	0x71	/* position filter parameters */
79 #define CMD_CHEIGHTFILT	0x73	/* height filter control */
80 #define CMD_CHIGH8CNT	0x75	/* high-8 (best 4) / high-6 (overdetermined) control */
81 #define CMD_CMAXDGPSCOR	0x77	/* maximum rate of DGPS corrections */
82 #define CMD_CSUPER	0x8E	/* super paket */
83 
84 #define CMD_RDATAA	0x3D	/* data channel A configuration:trimble_channelA:RO */
85 #define CMD_RALMANAC	0x40	/* almanac data for sat:gps_almanac:RO */
86 #define CMD_RCURTIME	0x41	/* GPS time:gps_time:RO */
87 #define CMD_RSPOSXYZ	0x42	/* single precision XYZ position:gps_position(XYZ):RO|DEF */
88 #define CMD_RVELOXYZ	0x43	/* velocity fix (XYZ ECEF):gps_velocity(XYZ):RO|DEF */
89 #define	CMD_RBEST4	0x44	/* best 4 satellite selection:trimble_best4:RO|DEF */
90 #define CMD_RVERSION	0x45	/* software version:trimble_version:RO|DEF */
91 #define CMD_RRECVHEALTH	0x46	/* receiver health:trimble_receiver_health:RO|DEF */
92 #define CMD_RSIGNALLV	0x47	/* signal levels of all satellites:trimble_signal_levels:RO */
93 #define CMD_RMESSAGE	0x48	/* GPS system message:gps-message:RO|DEF */
94 #define CMD_RALMAHEALTH	0x49	/* almanac health page for all satellites:gps_almanac_health:RO */
95 #define CMD_RSLLAPOS	0x4A	/* single LLA position:gps_position(LLA):RO|DEF */
96 #define CMD_RMACHSTAT	0x4B	/* machine code / status:trimble_status:RO|DEF */
97 #define CMD_ROPERPARAM	0x4C	/* operating parameters:trimble_opparam:RO */
98 #define CMD_ROSCOFFSET	0x4D	/* oscillator offset:trimble_oscoffset:RO */
99 #define CMD_RSETGPSTIME	0x4E	/* response to set GPS time:trimble_setgpstime:RO */
100 #define CMD_RUTCPARAM	0x4F	/* UTC parameters:gps_utc_correction:RO|DEF */
101 #define CMD_RANALOGDIG	0x53	/* analog to digital:trimble_analogdigital:RO */
102 #define CMD_RSAT1BIAS	0x54	/* one-satellite bias & bias rate:trimble_sat1bias:RO */
103 #define CMD_RIOOPTIONS	0x55	/* I/O options:trimble_iooptions:RO */
104 #define CMD_RVELOCFIX	0x56	/* velocity fix (ENU):trimble_velocfix */
105 #define CMD_RSTATLSTFIX	0x57	/* status and values of last pos. and vel.:trimble_status_lastpos:RO */
106 #define CMD_RLOADSSATDT	0x58	/* response to load satellite system data:trimble_loaddata:RO */
107 #define CMD_RSATDISABLE	0x59	/* satellite disable:trimble_satdisble:RO */
108 #define CMD_RLASTRAW	0x5A	/* last raw measurement:trimble_lastraw:RO */
109 #define CMD_RSTATSATEPH	0x5B	/* satellite ephemeris status:trimble_ephstatus:RO */
110 #define CMD_RSTATTRACK	0x5C	/* tracking status:trimble_tracking_status:RO|DEF */
111 #define CMD_RADDITFIX	0x5E	/* additional fix data:trimble_addfix:RO */
112 #define CMD_RALLINVIEW	0x6D	/* all in view satellite selection:trimble_satview:RO|DEF */
113 #define CMD_RPOSFILT	0x72	/* position filter parameters:trimble_posfilt:RO */
114 #define CMD_RHEIGHTFILT	0x74	/* height filter control:trimble_heightfilt:RO */
115 #define CMD_RHIGH8CNT	0x76	/* high-8 (best 4) / high-6 (overdetermined) control:trimble_high8control:RO */
116 #define CMD_RMAXAGE	0x78	/* DC MaxAge:trimble_dgpsmaxage:RO */
117 #define CMD_RDGPSFIX	0x82	/* differential position fix mode:trimble_dgpsfixmode:RO */
118 #define CMD_RDOUBLEXYZ	0x83	/* double precision XYZ:gps_position_ext(XYZ):RO|DEF */
119 #define CMD_RDOUBLELLA	0x84	/* double precision LLA:gps_position_ext(LLA):RO|DEF */
120 #define CMD_RDGPSSTAT	0x85	/* differential correction status:trimble_dgpsstatus:RO */
121 #define CMD_RSUPER	0x8F	/* super paket::0 */
122 
123 typedef struct cmd_info
124 {
125   unsigned char cmd;		/* command code */
126   const char   *cmdname;	/* command name */
127   const char   *cmddesc;	/* command description */
128   const char   *varname;	/* name of variable */
129   int           varmode;	/* mode of variable */
130 } cmd_info_t;
131 
132 extern cmd_info_t trimble_rcmds[];
133 extern cmd_info_t trimble_scmds[];
134 
135 extern cmd_info_t *trimble_convert (unsigned int cmd, cmd_info_t *tbl);
136 
137 #endif
138 /*
139  * History:
140  *
141  * trimble.h,v
142  * Revision 4.6  2005/04/16 17:32:10  kardel
143  * update copyright
144  *
145  * Revision 4.5  2004/11/14 15:29:41  kardel
146  * support PPSAPI, upgrade Copyright to Berkeley style
147  *
148  * Revision 4.4  1999/02/28 11:41:11  kardel
149  * (CMD_RUTCPARAM): control variable name unification
150  *
151  * Revision 4.3  1998/12/20 23:45:25  kardel
152  * fix types and warnings
153  *
154  * Revision 4.2  1998/08/16 18:45:05  kardel
155  * (CMD_RSTATTRACK): renamed mode 6 variable name
156  *
157  * Revision 4.1  1998/08/09 22:24:35  kardel
158  * Trimble TSIP support
159  *
160  */
161