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