Project

General

Profile

Download (26 KB) Statistics
| Branch: | Tag: | Revision:
1 aa2aebfd nagyrobi
<?php
2
/* $Id$ */
3
/*
4 ce77a9c4 Phil Davis
	services_ntpd_gps.php
5
6
	Copyright (C) 2013-2015 Electric Sheep Fencing, LP
7 aa2aebfd nagyrobi
	Copyright (C) 2013	Dagorlad
8
	Copyright (C) 2012	Jim Pingle
9
	All rights reserved.
10
11
	Redistribution and use in source and binary forms, with or without
12
	modification, are permitted provided that the following conditions are met:
13
14
	1. Redistributions of source code must retain the above copyright notice,
15
	   this list of conditions and the following disclaimer.
16
17
	2. Redistributions in binary form must reproduce the above copyright
18
	   notice, this list of conditions and the following disclaimer in the
19
	   documentation and/or other materials provided with the distribution.
20
21
	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
22
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
23
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24
	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
25
	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26
	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28
	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29
	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30
	POSSIBILITY OF SUCH DAMAGE.
31
*/
32
/*
33
	pfSense_MODULE:	ntpd_gps
34
*/
35
36
##|+PRIV
37
##|*IDENT=page-services-ntpd-gps
38
##|*NAME=Services: NTP Serial GPS page
39
##|*DESCR=Allow access to the 'Services: NTP Serial GPS' page..
40
##|*MATCH=services_ntpd_gps.php*
41
##|-PRIV
42
43 a3498099 Ermal
require_once("guiconfig.inc");
44 aa2aebfd nagyrobi
45
function set_default_gps() {
46 a3498099 Ermal
	global $config;
47
48
	if (!is_array($config['ntpd']))
49
		$config['ntpd'] = array();
50 42b5c637 Renato Botelho
	if (is_array($config['ntpd']['gps']))
51 a3498099 Ermal
		unset($config['ntpd']['gps']);
52
53
	$config['ntpd']['gps'] = array();
54 aa2aebfd nagyrobi
	$config['ntpd']['gps']['type'] = 'Default';
55
	/* copy an existing configured GPS port if it exists, the unset may be uncommented post production */
56 a3498099 Ermal
	if (!empty($config['ntpd']['gpsport']) && empty($config['ntpd']['gps']['port'])) {
57 aa2aebfd nagyrobi
		$config['ntpd']['gps']['port'] = $config['ntpd']['gpsport'];
58 a3498099 Ermal
		unset($config['ntpd']['gpsport']); /* this removes the original port config from config.xml */
59
		$config['ntpd']['gps']['speed'] = 0;
60
		$config['ntpd']['gps']['nmea'] = 0;
61 aa2aebfd nagyrobi
	}
62 a3498099 Ermal
63
	write_config("Setting default NTPd settings");
64 aa2aebfd nagyrobi
}
65
66
if ($_POST) {
67
68
	unset($input_errors);
69
70 46f5ced5 Renato Botelho
	if (!empty($_POST['gpsport']) && file_exists('/dev/'.$_POST['gpsport']))
71
		$config['ntpd']['gps']['port'] = $_POST['gpsport'];
72
	/* if port is not set, remove all the gps config */
73
	else unset($config['ntpd']['gps']);
74
75
	if (!empty($_POST['gpstype']))
76 3be4caf9 Jean Cyr
		$config['ntpd']['gps']['type'] = $_POST['gpstype'];
77 46f5ced5 Renato Botelho
	elseif (isset($config['ntpd']['gps']['type']))
78
		unset($config['ntpd']['gps']['type']);
79
80
	if (!empty($_POST['gpsspeed']))
81
		$config['ntpd']['gps']['speed'] = $_POST['gpsspeed'];
82
	elseif (isset($config['ntpd']['gps']['speed']))
83
		unset($config['ntpd']['gps']['speed']);
84
85
	if (!empty($_POST['gpsnmea']) && ($_POST['gpsnmea'][0] === "0"))
86
		$config['ntpd']['gps']['nmea'] = "0";
87
	else
88
		$config['ntpd']['gps']['nmea'] = strval(array_sum($_POST['gpsnmea']));
89
90
	if (!empty($_POST['gpsfudge1']))
91
		$config['ntpd']['gps']['fudge1'] = $_POST['gpsfudge1'];
92
	elseif (isset($config['ntpd']['gps']['fudge1']))
93
		unset($config['ntpd']['gps']['fudge1']);
94
95
	if (!empty($_POST['gpsfudge2']))
96
		$config['ntpd']['gps']['fudge2'] = $_POST['gpsfudge2'];
97
	elseif (isset($config['ntpd']['gps']['fudge2']))
98
		unset($config['ntpd']['gps']['fudge2']);
99
100
	if (!empty($_POST['gpsstratum']) && ($_POST['gpsstratum']) < 17 )
101
		$config['ntpd']['gps']['stratum'] = $_POST['gpsstratum'];
102
	elseif (isset($config['ntpd']['gps']['stratum']))
103
		unset($config['ntpd']['gps']['stratum']);
104
105
	if (empty($_POST['gpsprefer']))
106
		$config['ntpd']['gps']['prefer'] = 'on';
107
	elseif (isset($config['ntpd']['gps']['prefer']))
108
		unset($config['ntpd']['gps']['prefer']);
109
110
	if (!empty($_POST['gpsselect']))
111
		$config['ntpd']['gps']['noselect'] = $_POST['gpsselect'];
112
	elseif (isset($config['ntpd']['gps']['noselect']))
113
		unset($config['ntpd']['gps']['noselect']);
114
115
	if (!empty($_POST['gpsflag1']))
116
		$config['ntpd']['gps']['flag1'] = $_POST['gpsflag1'];
117
	elseif (isset($config['ntpd']['gps']['flag1']))
118
		unset($config['ntpd']['gps']['flag1']);
119
120
	if (!empty($_POST['gpsflag2']))
121
		$config['ntpd']['gps']['flag2'] = $_POST['gpsflag2'];
122
	elseif (isset($config['ntpd']['gps']['flag2']))
123
		unset($config['ntpd']['gps']['flag2']);
124
125
	if (!empty($_POST['gpsflag3']))
126
		$config['ntpd']['gps']['flag3'] = $_POST['gpsflag3'];
127
	elseif (isset($config['ntpd']['gps']['flag3']))
128
		unset($config['ntpd']['gps']['flag3']);
129
130
	if (!empty($_POST['gpsflag4']))
131
		$config['ntpd']['gps']['flag4'] = $_POST['gpsflag4'];
132
	elseif (isset($config['ntpd']['gps']['flag4']))
133
		unset($config['ntpd']['gps']['flag4']);
134
135
	if (!empty($_POST['gpssubsec']))
136
		$config['ntpd']['gps']['subsec'] = $_POST['gpssubsec'];
137
	elseif (isset($config['ntpd']['gps']['subsec']))
138
		unset($config['ntpd']['gps']['subsec']);
139
140
	if (!empty($_POST['gpsrefid']))
141
		$config['ntpd']['gps']['refid'] = $_POST['gpsrefid'];
142
	elseif (isset($config['ntpd']['gps']['refid']))
143
		unset($config['ntpd']['gps']['refid']);
144 42b5c637 Renato Botelho
145 46f5ced5 Renato Botelho
	if (!empty($_POST['gpsinitcmd']))
146
		$config['ntpd']['gps']['initcmd'] = base64_encode($_POST['gpsinitcmd']);
147
	elseif (isset($config['ntpd']['gps']['initcmd']))
148
		unset($config['ntpd']['gps']['initcmd']);
149
150
	write_config("Updated NTP GPS Settings");
151
152
	$retval = system_ntp_configure();
153
	$savemsg = get_std_save_message($retval);
154 a3498099 Ermal
} else {
155 aa2aebfd nagyrobi
	/* set defaults if they do not already exist */
156 a3498099 Ermal
	if (!is_array($config['ntpd']) || !is_array($config['ntpd']['gps']) || empty($config['ntpd']['gps']['type'])) {
157 aa2aebfd nagyrobi
		set_default_gps();
158
	}
159
}
160 9c37d703 Colin Fleming
$closehead = false;
161 aa2aebfd nagyrobi
$pconfig = &$config['ntpd']['gps'];
162
$pgtitle = array(gettext("Services"),gettext("NTP GPS"));
163
$shortcut_section = "ntp";
164
include("head.inc");
165
?>
166
167
<script type="text/javascript">
168 9c37d703 Colin Fleming
//<![CDATA[
169 aa2aebfd nagyrobi
	function show_advanced(showboxID, configvalueID) {
170
		document.getElementById(showboxID).innerHTML='';
171
		aodiv = document.getElementById(configvalueID);
172
		aodiv.style.display = "block";
173
	}
174 42b5c637 Renato Botelho
175 aa2aebfd nagyrobi
	function ToggleOther(clicked, checkOff) {
176
		if (document.getElementById(clicked).checked) {
177
			document.getElementById(checkOff).checked=false;
178
		}
179
	}
180
181 f9f3e44c Renato Botelho
/*
182 aa2aebfd nagyrobi
init commands are Base64 encoded
183
Default =	#Sponsored, probably a Ublox
184
		$PUBX,40,GSV,0,0,0,0*59
185
		$PUBX,40,GLL,0,0,0,0*5C
186
		$PUBX,40,ZDA,0,0,0,0*44
187
		$PUBX,40,VTG,0,0,0,0*5E
188
		$PUBX,40,GSV,0,0,0,0*59
189
		$PUBX,40,GSA,0,0,0,0*4E
190
		$PUBX,40,GGA,0,0,0,0
191
		$PUBX,40,TXT,0,0,0,0
192
		$PUBX,40,RMC,0,0,0,0*46
193
		$PUBX,41,1,0007,0003,4800,0
194
		$PUBX,40,ZDA,1,1,1,1
195
196
Generic =					#do nothing
197 42b5c637 Renato Botelho
198 aa2aebfd nagyrobi
Garmin =	#most Garmin
199
		$PGRMC,,,,,,,,,,3,,2,4*52	#enable PPS @ 100ms
200
		$PGRMC1,,1,,,,,,W,,,,,,,*30	#enable WAAS
201
		$PGRMO,,3*74			#turn off all sentences
202
		$PGRMO,GPRMC,1*3D		#enable RMC
203
		$PGRMO,GPGGA,1*20		#enable GGA
204
		$PGRMO,GPGLL,1*26		#enable GLL
205
206
MediaTek =	#Adafruit, Fastrax, some Garmin and others
207
		$PMTK225,0*2B			#normal power mode
208
		$PMTK314,1,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0*28	#enable GLL, RMC, GGA and ZDA
209
		$PMTK301,2*2E			#enable WAAS
210
		$PMTK320,0*2F			#power save off
211
		$PMTK330,0*2E			#set WGS84 datum
212
		$PMTK386,0*23			#disable static navigation (MT333X)
213
		$PMTK397,0*23			#disable static navigation (MT332X)
214
		$PMTK251,4800*14		#4800 baud rate
215
216
SiRF =		#used by many devices
217 42b5c637 Renato Botelho
		$PSRF103,00,00,01,01*25		#turn on GGA
218 aa2aebfd nagyrobi
		$PSRF103,01,00,01,01*24		#turn on GLL
219
		$PSRF103,02,00,00,01*24		#turn off GSA
220
		$PSRF103,03,00,00,01*24		#turn off GSV
221
		$PSRF103,04,00,01,01*24		#turn on RMC
222
		$PSRF103,05,00,00,01*24		#turn off VTG
223
		$PSRF100,1,4800,8,1,0*0E	#set port to 4800,N,8,1
224
225
U-Blox =	#U-Blox 5, 6 and probably 7
226
		$PUBX,40,GGA,1,1,1,1,0,0*5A	#turn on GGA all ports
227
		$PUBX,40,GLL,1,1,1,1,0,0*5C	#turn on GLL all ports
228
		$PUBX,40,GSA,0,0,0,0,0,0*4E	#turn off GSA all ports
229
		$PUBX,40,GSV,0,0,0,0,0,0*59	#turn off GSV all ports
230
		$PUBX,40,RMC,1,1,1,1,0,0*47	#turn on RMC all ports
231
		$PUBX,40,VTG,0,0,0,0,0,0*5E	#turn off VTG all ports
232
		$PUBX,40,GRS,0,0,0,0,0,0*5D	#turn off GRS all ports
233
		$PUBX,40,GST,0,0,0,0,0,0*5B	#turn off GST all ports
234
		$PUBX,40,ZDA,1,1,1,1,0,0*44	#turn on ZDA all ports
235
		$PUBX,40,GBS,0,0,0,0,0,0*4D	#turn off GBS all ports
236
		$PUBX,40,DTM,0,0,0,0,0,0*46	#turn off DTM all ports
237
		$PUBX,40,GPQ,0,0,0,0,0,0*5D	#turn off GPQ all ports
238
		$PUBX,40,TXT,0,0,0,0,0,0*43	#turn off TXT all ports
239
		$PUBX,40,THS,0,0,0,0,0,0*54	#turn off THS all ports (U-Blox 6)
240
		$PUBX,41,1,0007,0003,4800,0*13	# set port 1 to 4800 baud
241 42b5c637 Renato Botelho
242 aa2aebfd nagyrobi
SureGPS = 		#Sure Electronics SKG16B
243
		$PMTK225,0*2B
244
		$PMTK314,1,1,0,1,0,5,0,0,0,0,0,0,0,0,0,0,0,1,0*2D
245
		$PMTK301,2*2E
246
		$PMTK397,0*23
247
		$PMTK102*31
248
		$PMTK313,1*2E
249
		$PMTK513,1*28
250
		$PMTK319,0*25
251
		$PMTK527,0.00*00
252
		$PMTK251,9600*17	#really needs to work at 9600 baud
253 42b5c637 Renato Botelho
254 f9f3e44c Renato Botelho
*/
255 aa2aebfd nagyrobi
256
	function set_gps_default(form) {
257
		//This handles a new config and also a reset to a defined default config
258
		var gpsdef = new Object();
259
		//get the text description of the selected type
260
		var e = document.getElementById("gpstype");
261
		var type = e.options[e.selectedIndex].text;
262
263
		//stuff the JS object as needed for each type
264
		switch(type) {
265
			case "Default":
266
				gpsdef['nmea'] = 0;
267
				gpsdef['speed'] = 0;
268
				gpsdef['fudge1'] = "0.155";
269
				gpsdef['fudge2'] = "";
270
				gpsdef['inittxt'] = "JFBVQlgsNDAsR1NWLDAsMCwwLDAqNTkNCiRQVUJYLDQwLEdMTCwwLDAsMCwwKjVDDQokUFVCWCw0MCxaREEsMCwwLDAsMCo0NA0KJFBVQlgsNDAsVlRHLDAsMCwwLDAqNUUNCiRQVUJYLDQwLEdTViwwLDAsMCwwKjU5DQokUFVCWCw0MCxHU0EsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR0dBLDAsMCwwLDANCiRQVUJYLDQwLFRYVCwwLDAsMCwwDQokUFVCWCw0MCxSTUMsMCwwLDAsMCo0Ng0KJFBVQlgsNDEsMSwwMDA3LDAwMDMsNDgwMCwwDQokUFVCWCw0MCxaREEsMSwxLDEsMQ0K";
271
				break;
272
273
			case "Garmin":
274
				gpsdef['nmea'] = 0;
275
				gpsdef['speed'] = 0;
276
				gpsdef['fudge1'] = "";
277
				gpsdef['fudge2'] = "0.600";
278
				gpsdef['inittxt'] = "JFBHUk1DLCwsLCwsLCwsLDMsLDIsOCo1RQ0KJFBHUk1DMSwsMSwsLCwsLFcsLCwsLCwsKjMwDQokUEdSTU8sLDMqNzQNCiRQR1JNTyxHUFJNQywxKjNEDQokUEdSTU8sR1BHR0EsMSoyMA0KJFBHUk1PLEdQR0xMLDEqMjYNCg==";
279
				break;
280 42b5c637 Renato Botelho
281 aa2aebfd nagyrobi
			case "Generic":
282
				gpsdef['nmea'] = 0;
283
				gpsdef['speed'] = 0;
284
				gpsdef['fudge1'] = "";
285
				gpsdef['fudge2'] = "0.400";
286
				gpsdef['inittxt'] = "";
287
				break;
288
289
			case "MediaTek":
290
				gpsdef['nmea'] = 0;
291
				gpsdef['speed'] = 0;
292
				gpsdef['fudge1'] = "";
293
				gpsdef['fudge2'] = "0.400";
294
				gpsdef['inittxt'] = "JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDAsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyOA0KJFBNVEszMDEsMioyRQ0KJFBNVEszMjAsMCoyRg0KJFBNVEszMzAsMCoyRQ0KJFBNVEszODYsMCoyMw0KJFBNVEszOTcsMCoyMw0KJFBNVEsyNTEsNDgwMCoxNA0K";
295
				break;
296
297
			case "SiRF":
298
				gpsdef['nmea'] = 0;
299
				gpsdef['speed'] = 0;
300
				gpsdef['fudge1'] = "";
301
				gpsdef['fudge2'] = "0.704"; //valid for 4800, 0.688 @ 9600, 0.640 @ USB
302
				gpsdef['inittxt'] = "JFBTUkYxMDMsMDAsMDAsMDEsMDEqMjUNCiRQU1JGMTAzLDAxLDAwLDAxLDAxKjI0DQokUFNSRjEwMywwMiwwMCwwMCwwMSoyNA0KJFBTUkYxMDMsMDMsMDAsMDAsMDEqMjQNCiRQU1JGMTAzLDA0LDAwLDAxLDAxKjI0DQokUFNSRjEwMywwNSwwMCwwMCwwMSoyNA0KJFBTUkYxMDAsMSw0ODAwLDgsMSwwKjBFDQo=";
303
				break;
304
305
			case "U-Blox":
306
				gpsdef['nmea'] = 0;
307
				gpsdef['speed'] = 0;
308
				gpsdef['fudge1'] = "";
309
				gpsdef['fudge2'] = "0.400";
310
				gpsdef['inittxt'] = "JFBVQlgsNDAsR0dBLDEsMSwxLDEsMCwwKjVBDQokUFVCWCw0MCxHTEwsMSwxLDEsMSwwLDAqNUMNCiRQVUJYLDQwLEdTQSwwLDAsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR1NWLDAsMCwwLDAsMCwwKjU5DQokUFVCWCw0MCxSTUMsMSwxLDEsMSwwLDAqNDcNCiRQVUJYLDQwLFZURywwLDAsMCwwLDAsMCo1RQ0KJFBVQlgsNDAsR1JTLDAsMCwwLDAsMCwwKjVEDQokUFVCWCw0MCxHU1QsMCwwLDAsMCwwLDAqNUINCiRQVUJYLDQwLFpEQSwxLDEsMSwxLDAsMCo0NA0KJFBVQlgsNDAsR0JTLDAsMCwwLDAsMCwwKjREDQokUFVCWCw0MCxEVE0sMCwwLDAsMCwwLDAqNDYNCiRQVUJYLDQwLEdQUSwwLDAsMCwwLDAsMCo1RA0KJFBVQlgsNDAsVFhULDAsMCwwLDAsMCwwKjQzDQokUFVCWCw0MCxUSFMsMCwwLDAsMCwwLDAqNTQNCiRQVUJYLDQxLDEsMDAwNywwMDAzLDQ4MDAsMCoxMw0K";
311
				break;
312
313
			case "SureGPS":
314 151693da nagyrobi
				gpsdef['nmea'] = 1;
315 aa2aebfd nagyrobi
				gpsdef['speed'] = 16;
316
				gpsdef['fudge1'] = "";
317 151693da nagyrobi
				gpsdef['fudge2'] = "0.407";
318 aa2aebfd nagyrobi
				gpsdef['inittxt'] = "JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDUsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyRA0KJFBNVEszMDEsMioyRQ0KJFBNVEszOTcsMCoyMw0KJFBNVEsxMDIqMzENCiRQTVRLMzEzLDEqMkUNCiRQTVRLNTEzLDEqMjgNCiRQTVRLMzE5LDAqMjUNCiRQTVRLNTI3LDAuMDAqMDANCiRQTVRLMjUxLDk2MDAqMTcNCg==";
319
				break;
320 8e2a4091 Renato Botelho
			default:
321
				return;
322
		}
323 aa2aebfd nagyrobi
324
		//then update the html and set the common stuff
325
		document.getElementById("gpsnmea").selectedIndex = gpsdef['nmea'];
326
		document.getElementById("gpsspeed").selectedIndex = gpsdef['speed'];
327
		form.gpsfudge1.value = gpsdef['fudge1'];
328
		form.gpsfudge2.value = gpsdef['fudge2'];
329
		form.gpsstratum.value = "";
330
		form.gpsrefid.value = "";
331
		form.gpsspeed.value = gpsdef['speed'];
332
		document.getElementById("gpsflag1").checked=true
333
		document.getElementById("gpsflag2").checked=false
334
		document.getElementById("gpsflag3").checked=true
335
		document.getElementById("gpsflag4").checked=false
336
		document.getElementById("gpssubsec").checked=false
337
		form.gpsinitcmd.value = atob(gpsdef['inittxt']);
338
	}
339
340
	//function to compute a NMEA checksum derived from the public domain function at http://www.hhhh.org/wiml/proj/nmeaxor.html
341
	function NMEAChecksum(cmd) {
342
		// Compute the checksum by XORing all the character values in the string.
343
		var checksum = 0;
344
		for(var i = 0; i < cmd.length; i++) {
345
			checksum = checksum ^ cmd.charCodeAt(i);
346
		}
347
		// Convert it to hexadecimal (base-16, upper case, most significant byte first).
348
		var hexsum = Number(checksum).toString(16).toUpperCase();
349
		if (hexsum.length < 2) {
350
			hexsum = ("00" + hexsum).slice(-2);
351
		}
352
		// Display the result
353
		document.getElementById("nmeachecksum").innerHTML = hexsum;
354
	}
355 9c37d703 Colin Fleming
//]]>
356 aa2aebfd nagyrobi
</script>
357 9c37d703 Colin Fleming
</head>
358 aa2aebfd nagyrobi
<body link="#0000CC" vlink="#0000CC" alink="#0000CC">
359
<?php include("fbegin.inc"); ?>
360
<form action="services_ntpd_gps.php" method="post" name="iform" id="iform" accept-charset="utf-8">
361
<?php if ($input_errors) print_input_errors($input_errors); ?>
362
<?php if ($savemsg) print_info_box($savemsg); ?>
363
364 9c37d703 Colin Fleming
<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="ntpd gps">
365 42b5c637 Renato Botelho
	<tr><td>
366 aa2aebfd nagyrobi
<?php
367 f9f3e44c Renato Botelho
		$tab_array = array();
368
		$tab_array[] = array(gettext("NTP"), false, "services_ntpd.php");
369
		$tab_array[] = array(gettext("Serial GPS"), true, "services_ntpd_gps.php");
370
		$tab_array[] = array(gettext("PPS"), false, "services_ntpd_pps.php");
371
		display_top_tabs($tab_array);
372 aa2aebfd nagyrobi
?>
373 42b5c637 Renato Botelho
	</td></tr>
374
	<tr><td>
375 aa2aebfd nagyrobi
	<div id="mainarea">
376 9c37d703 Colin Fleming
	<table class="tabcont" width="100%" border="0" cellpadding="6" cellspacing="0" summary="main area">
377 aa2aebfd nagyrobi
		<tr>
378
			<td colspan="2" valign="top" class="listtopic"><?=gettext("NTP Serial GPS Configuration"); ?></td>
379
		</tr>
380
		<tr>
381
			<td width="22%" valign="top" class="vncellreq">
382
			</td>
383
			<td width="78%" class="vtable">A GPS connected via a serial port may be used as a reference clock for NTP. If the GPS also supports PPS and is properly configured, and connected, that GPS may also be used as a Pulse Per Second clock reference. NOTE: a USB GPS may work, but is not recommended due to USB bus timing issues.
384 8cd558b6 ayvis
			<br />
385
			<br /><?php echo gettext("For the best results, NTP should have at least three sources of time. So it is best to configure at least 2 servers under"); ?> <a href="services_ntpd.php"><?php echo gettext("Services > NTP"); ?></a> <?php echo gettext("to minimize clock drift if the GPS data is not valid over time. Otherwise ntpd may only use values from the unsynchronized local clock when providing time to clients."); ?>
386 aa2aebfd nagyrobi
			</td>
387
		</tr>
388
		<tr>
389
			<td width="22%" valign="top" class="vncellreq"><?=gettext("GPS"); ?></td>
390
			<td width="78%" valign="top" class="vtable">
391 f9f3e44c Renato Botelho
				<!-- Start with the original "Default", list a "Generic" and then specific configs alphabetically -->
392 aa2aebfd nagyrobi
				<select id="gpstype" name="gpstype" class="formselect" onchange="set_gps_default(this.form)">
393 8e2a4091 Renato Botelho
					<option value="Custom"<?php if($pconfig['type'] == 'Custom') echo " selected=\"selected\""; ?>>Custom</option>
394 9c37d703 Colin Fleming
					<option value="Default"<?php if($pconfig['type'] == 'Default') echo " selected=\"selected\""; ?>>Default</option>
395
					<option value="Generic" title="Generic"<?php if($pconfig['type'] == 'Generic') echo " selected=\"selected\"";?>>Generic</option>
396
					<option value="Garmin" title="$PGRM... Most Garmin"<?php if($pconfig['type'] == 'Garmin') echo " selected=\"selected\"";?>>Garmin</option>
397
					<option value="MediaTek" title="$PMTK... Adafruit, Fastrax, some Garmin and others"<?php if($pconfig['type'] == 'MediaTek') echo " selected=\"selected\"";?>>MediaTek</option>
398
					<option value="SiRF" title="$PSRF... Used by many devices"<?php if($pconfig['type'] == 'sirf') echo " selected=\"selected\"";?>>SiRF</option>
399
					<option value="U-Blox" title="$PUBX... U-Blox 5, 6 and probably 7"<?php if($pconfig['type'] == 'U-Blox') echo " selected=\"selected\"";?>>U-Blox</option>
400
					<option value="SureGPS" title="$PMTK... Sure Electronics SKG16B"<?php if($pconfig['type'] == 'SureGPS') echo " selected=\"selected\"";?>>SureGPS</option>
401 aa2aebfd nagyrobi
				</select> <?php echo gettext("This option allows you to select a predefined configuration.");?>
402 8cd558b6 ayvis
				<br />
403
				<br />
404 f9f3e44c Renato Botelho
				<strong><?php echo gettext("Note: ");?></strong><?php echo gettext("Default is the configuration of pfSense 2.1 and earlier"); ?>
405
				<?php echo gettext(" (not recommended). Select Generic if your GPS is not listed.)"); ?><br />
406
				<strong><?php echo gettext("Note: ");?></strong><?php echo gettext("The perdefined configurations assume your GPS has already been set to NMEA mode."); ?>
407 aa2aebfd nagyrobi
			</td>
408
		</tr>
409
410 f9f3e44c Renato Botelho
<?php
411
	/* Probing would be nice, but much more complex. Would need to listen to each port for 1s+ and watch for strings. */
412
	$serialports = glob("/dev/cua?[0-9]{,.[0-9]}", GLOB_BRACE);
413
	if (!empty($serialports)):
414
?>
415 aa2aebfd nagyrobi
		<tr>
416
			<td width="22%" valign="top" class="vncellreq">Serial port</td>
417
			<td width="78%" class="vtable">
418
				<select name="gpsport" class="formselect">
419
					<option value="">none</option>
420 f9f3e44c Renato Botelho
<?php
421
				foreach ($serialports as $port):
422
					$shortport = substr($port,5);
423
					$selected = ($shortport == $pconfig['port']) ? " selected=\"selected\"" : "";
424
?>
425
					<option value="<?php echo $shortport;?>"<?php echo $selected;?>><?php echo $shortport;?></option>
426
<?php
427
				endforeach;
428
?>
429 aa2aebfd nagyrobi
				</select>&nbsp;
430
				<?php echo gettext("All serial ports are listed, be sure to pick the port with the GPS attached."); ?>
431 8cd558b6 ayvis
				<br /><br />
432 aa2aebfd nagyrobi
				<select id="gpsspeed" name="gpsspeed" class="formselect">
433 9c37d703 Colin Fleming
					<option value="0"<?php if(!$pconfig['speed']) echo " selected=\"selected\""; ?>>4800</option>
434
					<option value="16"<?php if($pconfig['speed'] === '16') echo " selected=\"selected\"";?>>9600</option>
435
					<option value="32"<?php if($pconfig['speed'] === '32') echo " selected=\"selected\"";?>>19200</option>
436
					<option value="48"<?php if($pconfig['speed'] === '48') echo " selected=\"selected\"";?>>38400</option>
437
					<option value="64"<?php if($pconfig['speed'] === '64') echo " selected=\"selected\"";?>>57600</option>
438
					<option value="80"<?php if($pconfig['speed'] === '80') echo " selected=\"selected\"";?>>115200</option>
439 aa2aebfd nagyrobi
				</select>&nbsp;<?php echo gettext("Serial port baud rate."); ?>
440 8cd558b6 ayvis
				<br />
441
				<br />
442 aa2aebfd nagyrobi
				<?php echo gettext("Note: A higher baud rate is generally only helpful if the GPS is sending too many sentences. It is recommended to configure the GPS to send only one sentence at a baud rate of 4800 or 9600."); ?>
443
			</td>
444
		</tr>
445 f9f3e44c Renato Botelho
<?php
446
	endif;
447
?>
448 aa2aebfd nagyrobi
		<tr>
449 f9f3e44c Renato Botelho
			<!-- 1 = RMC, 2 = GGA, 4 = GLL, 8 = ZDA or ZDG -->
450 aa2aebfd nagyrobi
			<td width="22%" valign="top" class="vncellreq">NMEA sentences</td>
451
			<td width="78%" class="vtable">
452 151693da nagyrobi
				<select id="gpsnmea" name="gpsnmea[]" multiple="multiple" class="formselect" size="5">
453 9c37d703 Colin Fleming
					<option value="0"<?php if(!$pconfig['nmea']) echo " selected=\"selected\""; ?>>All</option>
454 151693da nagyrobi
					<option value="1"<?php if($pconfig['nmea'] & 1) echo " selected=\"selected\"";?>>RMC</option>
455 9c37d703 Colin Fleming
					<option value="2"<?php if($pconfig['nmea'] & 2) echo " selected=\"selected\"";?>>GGA</option>
456
					<option value="4"<?php if($pconfig['nmea'] & 4) echo " selected=\"selected\"";?>>GLL</option>
457
					<option value="8"<?php if($pconfig['nmea'] & 8) echo " selected=\"selected\"";?>>ZDA or ZDG</option>
458 8cd558b6 ayvis
				</select><br />
459 aa2aebfd nagyrobi
				<?php echo gettext("By default NTP will listen for all supported NMEA sentences. Here one or more sentences to listen for may be specified."); ?>
460
			</td>
461
		</tr>
462
		<tr>
463
			<td width="22%" valign="top" class="vncellreq">Fudge time 1</td>
464
			<td width="78%" class="vtable">
465 9c37d703 Colin Fleming
				<input name="gpsfudge1" type="text" class="formfld unknown" id="gpsfudge1" min="-1" max="1" size="20" value="<?=htmlspecialchars($pconfig['fudge1']);?>" />(<?php echo gettext("seconds");?>)<br />
466 aa2aebfd nagyrobi
				<?php echo gettext("Fudge time 1 is used to specify the GPS PPS signal offset");?> (<?php echo gettext("default");?>: 0.0).</td>
467
		</tr>
468
		<tr>
469
			<td width="22%" valign="top" class="vncellreq">Fudge time 2</td>
470
			<td width="78%" class="vtable">
471 9c37d703 Colin Fleming
				<input name="gpsfudge2" type="text" class="formfld unknown" id="gpsfudge2" min="-1" max="1" size="20" value="<?=htmlspecialchars($pconfig['fudge2']);?>" />(<?php echo gettext("seconds");?>)<br />
472 aa2aebfd nagyrobi
				<?php echo gettext("Fudge time 2 is used to specify the GPS time offset");?> (<?php echo gettext("default");?>: 0.0).</td>
473
		</tr>
474
		<tr>
475
			<td width="22%" valign="top" class="vncellreq">Stratum</td>
476
			<td width="78%" class="vtable">
477 9c37d703 Colin Fleming
				<input name="gpsstratum" type="text" class="formfld unknown" id="gpsstratum" max="16" size="20" value="<?=htmlspecialchars($pconfig['stratum']);?>" /><?php echo gettext("(0-16)");?><br />
478 aa2aebfd nagyrobi
				<?php echo gettext("This may be used to change the GPS Clock stratum");?> (<?php echo gettext("default");?>: 0). <?php echo gettext("This may be useful if, for some reason, you want ntpd to prefer a different clock"); ?></td>
479
		</tr>
480
		<tr>
481
			<td width="22%" valign="top" class="vncellreq">Flags</td>
482
			<td width="78%" class="vtable">
483
				<table>
484
					<tr>
485
						<td>
486 8cd558b6 ayvis
				<?php echo gettext("Normally there should be no need to change these options from the defaults."); ?><br />
487 aa2aebfd nagyrobi
						</td>
488
					</tr>
489
				</table>
490
				<table>
491
					<tr>
492
						<td>
493 9c37d703 Colin Fleming
							<input name="gpsprefer" type="checkbox" class="formcheckbox" id="gpsprefer" onclick="ToggleOther('gpsprefer', 'gpsselect')"<?php if(!$pconfig['prefer']) echo " checked=\"checked\""; ?> />
494 aa2aebfd nagyrobi
						</td>
495
						<td>
496
							<span class="vexpl"><?php echo gettext("NTP should prefer this clock (default: enabled)."); ?></span>
497
						</td>
498
					</tr>
499
					<tr>
500
						<td>
501 9c37d703 Colin Fleming
							<input name="gpsselect" type="checkbox" class="formcheckbox" id="gpsselect" onclick="ToggleOther('gpsselect', 'gpsprefer')"<?php if($pconfig['noselect']) echo " checked=\"checked\""; ?> />
502 aa2aebfd nagyrobi
						</td>
503
						<td>
504
							<span class="vexpl"><?php echo gettext("NTP should not use this clock, it will be displayed for reference only(default: disabled)."); ?></span>
505
						</td>
506
					</tr>
507
					<tr>
508
						<td>
509 9c37d703 Colin Fleming
							<input name="gpsflag1" type="checkbox" class="formcheckbox" id="gpsflag1"<?php if($pconfig['flag1']) echo " checked=\"checked\""; ?> />
510 aa2aebfd nagyrobi
						</td>
511
						<td>
512
							<span class="vexpl"><?php echo gettext("Enable PPS signal processing (default: enabled)."); ?></span>
513
						</td>
514
					</tr>
515
					<tr>
516
						<td>
517 9c37d703 Colin Fleming
							<input name="gpsflag2" type="checkbox" class="formcheckbox" id="gpsflag2"<?php if($pconfig['flag2']) echo " checked=\"checked\""; ?> />
518 aa2aebfd nagyrobi
						</td>
519
						<td>
520
							<span class="vexpl"><?php echo gettext("Enable falling edge PPS signal processing (default: rising edge)."); ?></span>
521
						</td>
522
					</tr>
523
					<tr>
524
						<td>
525 9c37d703 Colin Fleming
							<input name="gpsflag3" type="checkbox" class="formcheckbox" id="gpsflag3"<?php if($pconfig['flag3']) echo " checked=\"checked\""; ?> />
526 aa2aebfd nagyrobi
						</td>
527
						<td>
528
							<span class="vexpl"><?php echo gettext("Enable kernel PPS clock discipline (default: enabled)."); ?></span>
529
						</td>
530
					</tr>
531
					<tr>
532
						<td>
533 9c37d703 Colin Fleming
							<input name="gpsflag4" type="checkbox" class="formcheckbox" id="gpsflag4"<?php if($pconfig['flag4']) echo " checked=\"checked\""; ?> />
534 aa2aebfd nagyrobi
						</td>
535
						<td>
536
							<span class="vexpl"><?php echo gettext("Obscure location in timestamp (default: unobscured)."); ?></span>
537
						</td>
538
					</tr>
539
					<tr>
540
						<td>
541 9c37d703 Colin Fleming
							<input name="gpssubsec" type="checkbox" class="formcheckbox" id="gpssubsec"<?php if($pconfig['subsec']) echo " checked=\"checked\""; ?> />
542 aa2aebfd nagyrobi
						</td>
543
						<td>
544 8cd558b6 ayvis
							<span class="vexpl"><?php echo gettext("Log the sub-second fraction of the received time stamp (default: Not logged).<br />Note: enabling this will rapidly fill the log, but is useful for tuning Fudge time 2."); ?></span>
545 aa2aebfd nagyrobi
						</td>
546
					</tr>
547
				</table>
548
			</td>
549
		</tr>
550
		<tr>
551
			<td width="22%" valign="top" class="vncellreq">Clock ID</td>
552
			<td width="78%" class="vtable">
553 9c37d703 Colin Fleming
				<input name="gpsrefid" type="text" class="formfld unknown" id="gpsrefid" maxlength= "4" size="20" value="<?=htmlspecialchars($pconfig['refid']);?>" /><?php echo gettext("(1 to 4 charactors)");?><br />
554 aa2aebfd nagyrobi
				<?php echo gettext("This may be used to change the GPS Clock ID");?> (<?php echo gettext("default");?>: GPS).</td>
555
		</tr>
556
		<tr>
557
			<td width="22%" valign="top" class="vncellreq">GPS Initialization</td>
558
			<td width="78%" class="vtable">
559
				<div id="showgpsinitbox">
560 9c37d703 Colin Fleming
					<input type="button" onclick="show_advanced('showgpsinitbox', 'showgpsinit')" value="<?=gettext("Advanced");?>" /> - <?=gettext("Show GPS Initialization commands");?>
561 aa2aebfd nagyrobi
				</div>
562
				<div id="showgpsinit" style="display:none">
563
					<p>
564
					<textarea name="gpsinitcmd" class="formpre" id="gpsinitcmd" cols="65" rows="7"><?=htmlspecialchars(base64_decode($pconfig['initcmd'])); /*resultmatch*/?></textarea><br />
565
					<?php echo gettext("Note: Commands entered here will be sent to the GPS during initialization. Please read and understand your GPS documentation before making any changes here.");?><br /><br />
566
					<strong><?php echo gettext("NMEA checksum calculator");?>:</strong>
567
					<br />
568 38505a80 Colin Fleming
					<?php echo gettext("Enter the text between &quot;$&quot; and &quot;*&quot; of a NMEA command string:");?><br /> $<input name="nmeastring" type="text" class="formfld unknown" id="nmeastring" size="30" value="" />*<span id="nmeachecksum"><?php echo gettext("checksum");?></span>&nbsp;&nbsp;
569 9c37d703 Colin Fleming
					<input type="button" onclick="NMEAChecksum(nmeastring.value)" value="<?=gettext("Calculate NMEA checksum");?>" /><br /></p>
570 aa2aebfd nagyrobi
				</div>
571
			</td>
572
		</tr>
573
		<tr>
574
			<td width="22%" valign="top">&nbsp;</td>
575
			<td width="78%">
576 9c37d703 Colin Fleming
			<input name="Submit" type="submit" class="formbtn" value="<?=gettext("Save");?>" />
577 aa2aebfd nagyrobi
			</td>
578
		</tr>
579
	</table>
580
	</div>
581 42b5c637 Renato Botelho
	</td></tr>
582 aa2aebfd nagyrobi
</table>
583 9c37d703 Colin Fleming
<script type="text/javascript">
584
//<![CDATA[
585
set_gps_default(this.form);
586
//]]>
587
</script>
588 aa2aebfd nagyrobi
</form>
589
<?php include("fend.inc"); ?>
590
</body>
591
</html>