diff options
Diffstat (limited to 'src/usr/local/www/services_ntpd_gps.php')
| -rw-r--r-- | src/usr/local/www/services_ntpd_gps.php | 718 |
1 files changed, 322 insertions, 396 deletions
diff --git a/src/usr/local/www/services_ntpd_gps.php b/src/usr/local/www/services_ntpd_gps.php index c8098c1..9bf100d 100644 --- a/src/usr/local/www/services_ntpd_gps.php +++ b/src/usr/local/www/services_ntpd_gps.php @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. */ /* - pfSense_MODULE: ntpd_gps + pfSense_MODULE: ntpd_gps */ ##|+PRIV @@ -66,7 +66,6 @@ function set_default_gps() { } if ($_POST) { - unset($input_errors); if (!empty($_POST['gpsport']) && file_exists('/dev/'.$_POST['gpsport'])) { @@ -176,444 +175,371 @@ if ($_POST) { set_default_gps(); } } + +function build_nmea_list() { + global $pconfig; + + $nmealist = array('options' => array(), 'selected' => array()); + + $nmealist['options'][0] = 'All'; + $nmealist['options'][1] = 'RMC'; + $nmealist['options'][2] = 'GGA'; + $nmealist['options'][4] = 'GLL'; + $nmealist['options'][8] = 'ZDA or ZDG'; + + if(!$pconfig['nmea']) + array_push($nmealist['selected'], 0); + + foreach($nmealist['options'] as $val => $opt) { + if($pconfig['nmea'] & $val) + array_push($nmealist['selected'], $val); + } + + return($nmealist); +} + $closehead = false; $pconfig = &$config['ntpd']['gps']; $pgtitle = array(gettext("Services"), gettext("NTP GPS")); $shortcut_section = "ntp"; include("head.inc"); + +$tab_array = array(); +$tab_array[] = array(gettext("NTP"), false, "services_ntpd.php"); +$tab_array[] = array(gettext("Serial GPS"), true, "services_ntpd_gps.php"); +$tab_array[] = array(gettext("PPS"), false, "services_ntpd_pps.php"); +display_top_tabs($tab_array); + +require('classes/Form.class.php'); + +$form = new Form; + +$section = new Form_Section('NTP Serial GPS Configuration'); + +$section->addInput(new Form_StaticText( + 'Notes', + '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.' . '<br />' . + '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">Services > NTP</a>' . + ' 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.' +)); + +$gpstypes = array('Custom', 'Default', 'Generic', 'Garmin', 'MediaTek', 'SiRF', 'U-Blox', 'SureGPS'); + +$section->addInput(new Form_Select( + 'gpstype', + 'GPS', + $pconfig['type'], + array_combine($gpstypes, $gpstypes) +))->setHelp('This option allows you to select a predefined configuration.' . + 'Default is the configuration of pfSense 2.1 and earlier (not recommended). Select Generic if your GPS is not listed.' . '<br /><br />' . + 'The perdefined configurations assume your GPS has already been set to NMEA mode.'); + +$serialports = glob("/dev/cua?[0-9]{,.[0-9]}", GLOB_BRACE); + +if (!empty($serialports)) { + $splist = array(); + + foreach ($serialports as $port) { + $shortport = substr($port,5); + $splist[$shortport] = $shortport; + } + + $section->addInput(new Form_Select( + 'gpsport', + 'Serial port', + $pconfig['port'], + $splist + ))->setHelp('All serial ports are listed, be sure to pick the port with the GPS attached. '); + + $section->addInput(new Form_Select( + 'gpsspeed', + null, + $pconfig['speed'], + [0 => '4800', 15 => '9600', 32 => '19200', 48 => '38400', 64 => '57600', 80 => '115200'] + + ))->setHelp('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.'); +} + +$nmealist = build_nmea_list(); +$section->addInput(new Form_Select( + 'gpsnmea', + 'NMEA Sentences', + $nmealist['selected'], + $nmealist['options'], + true +))->setHelp('By default NTP will listen for all supported NMEA sentences. One or more sentences to listen for may be specified.'); + +$section->addInput(new Form_Input( + 'gpsfudge1', + 'Fudge time 1', + 'text', + $pconfig['fudge1'] +))->setHelp('Fudge time 1 is used to specify the GPS PPS signal offset (default: 0.0).'); + +$section->addInput(new Form_Input( + 'gpsfudge2', + 'Fudge time 2', + 'text', + $pconfig['fudge2'] +))->setHelp('Fudge time 2 is used to specify the GPS time offset (default: 0.0).'); + +$section->addInput(new Form_Input( + 'gpsstratum', + 'Stratum (0-16)', + 'text', + $pconfig['stratum'] +))->setHelp('This may be used to change the GPS Clock stratum (default: 0). This may be useful if, for some reason, you want ntpd to prefer a different clock'); + +$section->addInput(new Form_Checkbox( + 'gpsprefer', + 'Flags', + 'NTP should prefer this clock (default: enabled).', + !$pconfig['prefer'] +)); + +$section->addInput(new Form_Checkbox( + 'gpsselect', + null, + 'NTP should not use this clock, it will be displayed for reference only(default: disabled).', + $pconfig['noselect'] +)); + +$section->addInput(new Form_Checkbox( + 'gpsflag1', + null, + 'Enable PPS signal processing (default: enabled).', + $pconfig['flag1'] +)); + +$section->addInput(new Form_Checkbox( + 'gpsflag2', + null, + 'Enable falling edge PPS signal processing (default: rising edge).', + $pconfig['flag2'] +)); + +$section->addInput(new Form_Checkbox( + 'gpsflag3', + null, + 'Enable kernel PPS clock discipline (default: enabled).', + $pconfig['flag3'] +)); + +$section->addInput(new Form_Checkbox( + 'gpsflag4', + null, + 'Obscure location in timestamp (default: unobscured).', + $pconfig['flag4'] +)); + +$section->addInput(new Form_Checkbox( + 'gpssubsec', + null, + 'Log the sub-second fraction of the received time stamp (default: Not logged).', + $pconfig['subsec'] +))->setHelp('Enabling this will rapidly fill the log, but is useful for tuning Fudge time 2.'); + +$section->addInput(new Form_Input( + 'gpsrefid', + 'Clock ID', + 'text', + $pconfig['refid'], + ['placeholder' => '1 to 4 characters'] +))->setHelp('This may be used to change the GPS Clock ID (default: GPS).'); + +// Statistics logging section +$btnadvgps = new Form_Button( + 'btnadvgps', + 'Advanced' +); + +$btnadvgps->removeClass('btn-primary')->addClass('btn-default btn-sm'); + +$section->addInput(new Form_StaticText( + 'GPS Initialization', + $btnadvgps . ' ' . 'Show GPS Initialization commands' +)); + +$section->addInput(new Form_Textarea( + 'gpsinitcmd', + null, + $pconfig['initcmd'] +))->setHelp('Commands entered here will be sent to the GPS during initialization. Please read and understand your GPS documentation before making any changes here'); + +$group = new Form_Group('NMEA Checksum Calculator'); + +$group->add(new Form_Input( + 'nmeastring', + null +)); + +$btncalc = new Form_Button( + 'btncalc', + 'Calculate' +); + +$btncalc->removeClass('btn-primary')->addClass('btn-success btn-sm'); + +$group->add($btncalc); + +$group->add(new Form_Input( + 'result', + null, + 'text', + null, + ['placeholder' => 'Result'] +)); + +$group->setHelp('Enter the text between "$" and "*" of a NMEA command string:'); +$group->addClass('calculator'); + +$section->add($group); + +$form->add($section); +print($form); + ?> -<script type="text/javascript"> +<script> //<![CDATA[ - function show_advanced(showboxID, configvalueID) { - document.getElementById(showboxID).innerHTML=''; - aodiv = document.getElementById(configvalueID); - aodiv.style.display = "block"; - } +events.push(function(){ - function ToggleOther(clicked, checkOff) { - if (document.getElementById(clicked).checked) { - document.getElementById(checkOff).checked=false; + function NMEAChecksum(cmd) { + // Compute the checksum by XORing all the character values in the string. + var checksum = 0; + + for(var i = 0; i < cmd.length; i++) { + checksum = checksum ^ cmd.charCodeAt(i); + } + // Convert it to hexadecimal (base-16, upper case, most significant byte first). + var hexsum = Number(checksum).toString(16).toUpperCase(); + + if (hexsum.length < 2) { + hexsum = ("00" + hexsum).slice(-2); } + + return(hexsum); } -/* -init commands are Base64 encoded -Default = #Sponsored, probably a Ublox - $PUBX,40,GSV,0,0,0,0*59 - $PUBX,40,GLL,0,0,0,0*5C - $PUBX,40,ZDA,0,0,0,0*44 - $PUBX,40,VTG,0,0,0,0*5E - $PUBX,40,GSV,0,0,0,0*59 - $PUBX,40,GSA,0,0,0,0*4E - $PUBX,40,GGA,0,0,0,0 - $PUBX,40,TXT,0,0,0,0 - $PUBX,40,RMC,0,0,0,0*46 - $PUBX,41,1,0007,0003,4800,0 - $PUBX,40,ZDA,1,1,1,1 - -Generic = #do nothing - -Garmin = #most Garmin - $PGRMC,,,,,,,,,,3,,2,4*52 #enable PPS @ 100ms - $PGRMC1,,1,,,,,,W,,,,,,,*30 #enable WAAS - $PGRMO,,3*74 #turn off all sentences - $PGRMO,GPRMC,1*3D #enable RMC - $PGRMO,GPGGA,1*20 #enable GGA - $PGRMO,GPGLL,1*26 #enable GLL - -MediaTek = #Adafruit, Fastrax, some Garmin and others - $PMTK225,0*2B #normal power mode - $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 - $PMTK301,2*2E #enable WAAS - $PMTK320,0*2F #power save off - $PMTK330,0*2E #set WGS84 datum - $PMTK386,0*23 #disable static navigation (MT333X) - $PMTK397,0*23 #disable static navigation (MT332X) - $PMTK251,4800*14 #4800 baud rate - -SiRF = #used by many devices - $PSRF103,00,00,01,01*25 #turn on GGA - $PSRF103,01,00,01,01*24 #turn on GLL - $PSRF103,02,00,00,01*24 #turn off GSA - $PSRF103,03,00,00,01*24 #turn off GSV - $PSRF103,04,00,01,01*24 #turn on RMC - $PSRF103,05,00,00,01*24 #turn off VTG - $PSRF100,1,4800,8,1,0*0E #set port to 4800,N,8,1 - -U-Blox = #U-Blox 5, 6 and probably 7 - $PUBX,40,GGA,1,1,1,1,0,0*5A #turn on GGA all ports - $PUBX,40,GLL,1,1,1,1,0,0*5C #turn on GLL all ports - $PUBX,40,GSA,0,0,0,0,0,0*4E #turn off GSA all ports - $PUBX,40,GSV,0,0,0,0,0,0*59 #turn off GSV all ports - $PUBX,40,RMC,1,1,1,1,0,0*47 #turn on RMC all ports - $PUBX,40,VTG,0,0,0,0,0,0*5E #turn off VTG all ports - $PUBX,40,GRS,0,0,0,0,0,0*5D #turn off GRS all ports - $PUBX,40,GST,0,0,0,0,0,0*5B #turn off GST all ports - $PUBX,40,ZDA,1,1,1,1,0,0*44 #turn on ZDA all ports - $PUBX,40,GBS,0,0,0,0,0,0*4D #turn off GBS all ports - $PUBX,40,DTM,0,0,0,0,0,0*46 #turn off DTM all ports - $PUBX,40,GPQ,0,0,0,0,0,0*5D #turn off GPQ all ports - $PUBX,40,TXT,0,0,0,0,0,0*43 #turn off TXT all ports - $PUBX,40,THS,0,0,0,0,0,0*54 #turn off THS all ports (U-Blox 6) - $PUBX,41,1,0007,0003,4800,0*13 # set port 1 to 4800 baud - -SureGPS = #Sure Electronics SKG16B - $PMTK225,0*2B - $PMTK314,1,1,0,1,0,5,0,0,0,0,0,0,0,0,0,0,0,1,0*2D - $PMTK301,2*2E - $PMTK397,0*23 - $PMTK102*31 - $PMTK313,1*2E - $PMTK513,1*28 - $PMTK319,0*25 - $PMTK527,0.00*00 - $PMTK251,9600*17 #really needs to work at 9600 baud + // Hides the <div> in which the specified input element lives so that the input, its label and help text are hidden + function hideInput(id, hide) { + if(hide) + $('#' + id).parent().parent('div').addClass('hidden'); + else + $('#' + id).parent().parent('div').removeClass('hidden'); + } -*/ + // Hides all elements of the specified class. This will usually be a section or group + function hideClass(s_class, hide) { + if(hide) + $('.' + s_class).hide(); + else + $('.' + s_class).show(); + } - function set_gps_default(form) { - //This handles a new config and also a reset to a defined default config - var gpsdef = new Object(); - //get the text description of the selected type - var e = document.getElementById("gpstype"); - var type = e.options[e.selectedIndex].text; + function set_gps_default(type) { + $('#gpsnmea').val(0); + $('#gpsspeed').val(0); + $('#gpsfudge1').val(0); //stuff the JS object as needed for each type switch (type) { case "Default": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = "0.155"; - gpsdef['fudge2'] = ""; - gpsdef['inittxt'] = "JFBVQlgsNDAsR1NWLDAsMCwwLDAqNTkNCiRQVUJYLDQwLEdMTCwwLDAsMCwwKjVDDQokUFVCWCw0MCxaREEsMCwwLDAsMCo0NA0KJFBVQlgsNDAsVlRHLDAsMCwwLDAqNUUNCiRQVUJYLDQwLEdTViwwLDAsMCwwKjU5DQokUFVCWCw0MCxHU0EsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR0dBLDAsMCwwLDANCiRQVUJYLDQwLFRYVCwwLDAsMCwwDQokUFVCWCw0MCxSTUMsMCwwLDAsMCo0Ng0KJFBVQlgsNDEsMSwwMDA3LDAwMDMsNDgwMCwwDQokUFVCWCw0MCxaREEsMSwxLDEsMQ0K"; + $('#gpsfudge1').val("0.155"); + $('#gpsfudge2').val(""); + $('#gpsinitcmd').val("JFBVQlgsNDAsR1NWLDAsMCwwLDAqNTkNCiRQVUJYLDQwLEdMTCwwLDAsMCwwKjVDDQokUFVCWCw0MCxaREEsMCwwLDAsMCo0NA0KJFBVQlgsNDAsVlRHLDAsMCwwLDAqNUUNCiRQVUJYLDQwLEdTViwwLDAsMCwwKjU5DQokUFVCWCw0MCxHU0EsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR0dBLDAsMCwwLDANCiRQVUJYLDQwLFRYVCwwLDAsMCwwDQokUFVCWCw0MCxSTUMsMCwwLDAsMCo0Ng0KJFBVQlgsNDEsMSwwMDA3LDAwMDMsNDgwMCwwDQokUFVCWCw0MCxaREEsMSwxLDEsMQ0K"); break; case "Garmin": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.600"; - gpsdef['inittxt'] = "JFBHUk1DLCwsLCwsLCwsLDMsLDIsOCo1RQ0KJFBHUk1DMSwsMSwsLCwsLFcsLCwsLCwsKjMwDQokUEdSTU8sLDMqNzQNCiRQR1JNTyxHUFJNQywxKjNEDQokUEdSTU8sR1BHR0EsMSoyMA0KJFBHUk1PLEdQR0xMLDEqMjYNCg=="; + $('#gpsfudge2').val("0.600"); + $('#gpsinitcmd').val("JFBHUk1DLCwsLCwsLCwsLDMsLDIsOCo1RQ0KJFBHUk1DMSwsMSwsLCwsLFcsLCwsLCwsKjMwDQokUEdSTU8sLDMqNzQNCiRQR1JNTyxHUFJNQywxKjNEDQokUEdSTU8sR1BHR0EsMSoyMA0KJFBHUk1PLEdQR0xMLDEqMjYNCg=="); break; case "Generic": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.400"; - gpsdef['inittxt'] = ""; + $('#gpsfudge2').val("0.400"); + $('#gpsinitcmd').val(""); break; case "MediaTek": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.400"; - gpsdef['inittxt'] = "JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDAsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyOA0KJFBNVEszMDEsMioyRQ0KJFBNVEszMjAsMCoyRg0KJFBNVEszMzAsMCoyRQ0KJFBNVEszODYsMCoyMw0KJFBNVEszOTcsMCoyMw0KJFBNVEsyNTEsNDgwMCoxNA0K"; + $('#gpsfudge2').val("0.400"); + $('#gpsinitcmd').val("JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDAsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyOA0KJFBNVEszMDEsMioyRQ0KJFBNVEszMjAsMCoyRg0KJFBNVEszMzAsMCoyRQ0KJFBNVEszODYsMCoyMw0KJFBNVEszOTcsMCoyMw0KJFBNVEsyNTEsNDgwMCoxNA0K"); break; case "SiRF": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.704"; //valid for 4800, 0.688 @ 9600, 0.640 @ USB - gpsdef['inittxt'] = "JFBTUkYxMDMsMDAsMDAsMDEsMDEqMjUNCiRQU1JGMTAzLDAxLDAwLDAxLDAxKjI0DQokUFNSRjEwMywwMiwwMCwwMCwwMSoyNA0KJFBTUkYxMDMsMDMsMDAsMDAsMDEqMjQNCiRQU1JGMTAzLDA0LDAwLDAxLDAxKjI0DQokUFNSRjEwMywwNSwwMCwwMCwwMSoyNA0KJFBTUkYxMDAsMSw0ODAwLDgsMSwwKjBFDQo="; + $('#gpsfudge2').val("0.704"); //valid for 4800, 0.688 @ 9600, 0.640 @ USB + $('#gpsinitcmd').val("JFBTUkYxMDMsMDAsMDAsMDEsMDEqMjUNCiRQU1JGMTAzLDAxLDAwLDAxLDAxKjI0DQokUFNSRjEwMywwMiwwMCwwMCwwMSoyNA0KJFBTUkYxMDMsMDMsMDAsMDAsMDEqMjQNCiRQU1JGMTAzLDA0LDAwLDAxLDAxKjI0DQokUFNSRjEwMywwNSwwMCwwMCwwMSoyNA0KJFBTUkYxMDAsMSw0ODAwLDgsMSwwKjBFDQo="); break; case "U-Blox": - gpsdef['nmea'] = 0; - gpsdef['speed'] = 0; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.400"; - gpsdef['inittxt'] = "JFBVQlgsNDAsR0dBLDEsMSwxLDEsMCwwKjVBDQokUFVCWCw0MCxHTEwsMSwxLDEsMSwwLDAqNUMNCiRQVUJYLDQwLEdTQSwwLDAsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR1NWLDAsMCwwLDAsMCwwKjU5DQokUFVCWCw0MCxSTUMsMSwxLDEsMSwwLDAqNDcNCiRQVUJYLDQwLFZURywwLDAsMCwwLDAsMCo1RQ0KJFBVQlgsNDAsR1JTLDAsMCwwLDAsMCwwKjVEDQokUFVCWCw0MCxHU1QsMCwwLDAsMCwwLDAqNUINCiRQVUJYLDQwLFpEQSwxLDEsMSwxLDAsMCo0NA0KJFBVQlgsNDAsR0JTLDAsMCwwLDAsMCwwKjREDQokUFVCWCw0MCxEVE0sMCwwLDAsMCwwLDAqNDYNCiRQVUJYLDQwLEdQUSwwLDAsMCwwLDAsMCo1RA0KJFBVQlgsNDAsVFhULDAsMCwwLDAsMCwwKjQzDQokUFVCWCw0MCxUSFMsMCwwLDAsMCwwLDAqNTQNCiRQVUJYLDQxLDEsMDAwNywwMDAzLDQ4MDAsMCoxMw0K"; + $('#gpsfudge2').val("0.400"); + $('#gpsinitcmd').val("JFBVQlgsNDAsR0dBLDEsMSwxLDEsMCwwKjVBDQokUFVCWCw0MCxHTEwsMSwxLDEsMSwwLDAqNUMNCiRQVUJYLDQwLEdTQSwwLDAsMCwwLDAsMCo0RQ0KJFBVQlgsNDAsR1NWLDAsMCwwLDAsMCwwKjU5DQokUFVCWCw0MCxSTUMsMSwxLDEsMSwwLDAqNDcNCiRQVUJYLDQwLFZURywwLDAsMCwwLDAsMCo1RQ0KJFBVQlgsNDAsR1JTLDAsMCwwLDAsMCwwKjVEDQokUFVCWCw0MCxHU1QsMCwwLDAsMCwwLDAqNUINCiRQVUJYLDQwLFpEQSwxLDEsMSwxLDAsMCo0NA0KJFBVQlgsNDAsR0JTLDAsMCwwLDAsMCwwKjREDQokUFVCWCw0MCxEVE0sMCwwLDAsMCwwLDAqNDYNCiRQVUJYLDQwLEdQUSwwLDAsMCwwLDAsMCo1RA0KJFBVQlgsNDAsVFhULDAsMCwwLDAsMCwwKjQzDQokUFVCWCw0MCxUSFMsMCwwLDAsMCwwLDAqNTQNCiRQVUJYLDQxLDEsMDAwNywwMDAzLDQ4MDAsMCoxMw0K"); break; case "SureGPS": - gpsdef['nmea'] = 1; - gpsdef['speed'] = 16; - gpsdef['fudge1'] = ""; - gpsdef['fudge2'] = "0.407"; - gpsdef['inittxt'] = "JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDUsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyRA0KJFBNVEszMDEsMioyRQ0KJFBNVEszOTcsMCoyMw0KJFBNVEsxMDIqMzENCiRQTVRLMzEzLDEqMkUNCiRQTVRLNTEzLDEqMjgNCiRQTVRLMzE5LDAqMjUNCiRQTVRLNTI3LDAuMDAqMDANCiRQTVRLMjUxLDk2MDAqMTcNCg=="; + $('#gpsnmea').val(1); + $('#gpsspeed').val(16); + $('#gpsfudge2').val("0.407"); + $('#gpsinitcmd').val("JFBNVEsyMjUsMCoyQg0KJFBNVEszMTQsMSwxLDAsMSwwLDUsMCwwLDAsMCwwLDAsMCwwLDAsMCwwLDEsMCoyRA0KJFBNVEszMDEsMioyRQ0KJFBNVEszOTcsMCoyMw0KJFBNVEsxMDIqMzENCiRQTVRLMzEzLDEqMkUNCiRQTVRLNTEzLDEqMjgNCiRQTVRLMzE5LDAqMjUNCiRQTVRLNTI3LDAuMDAqMDANCiRQTVRLMjUxLDk2MDAqMTcNCg=="); break; default: return; } - //then update the html and set the common stuff - document.getElementById("gpsnmea").selectedIndex = gpsdef['nmea']; - document.getElementById("gpsspeed").selectedIndex = gpsdef['speed']; - form.gpsfudge1.value = gpsdef['fudge1']; - form.gpsfudge2.value = gpsdef['fudge2']; - form.gpsstratum.value = ""; - form.gpsrefid.value = ""; - form.gpsspeed.value = gpsdef['speed']; - document.getElementById("gpsflag1").checked=true - document.getElementById("gpsflag2").checked=false - document.getElementById("gpsflag3").checked=true - document.getElementById("gpsflag4").checked=false - document.getElementById("gpssubsec").checked=false - form.gpsinitcmd.value = atob(gpsdef['inittxt']); + $('#gpsstratum').val(""); + $('#gpsrefid').val(""); + $('#gpsflag1').prop('checked', true); + $('#gpsflag2').prop('checked', false); + $('#gpsflag3').prop('checked', true); + $('#gpsflag4').prop('checked', false); + $('#gpssubsec').prop('checked', false); } - //function to compute a NMEA checksum derived from the public domain function at http://www.hhhh.org/wiml/proj/nmeaxor.html - function NMEAChecksum(cmd) { - // Compute the checksum by XORing all the character values in the string. - var checksum = 0; - for (var i = 0; i < cmd.length; i++) { - checksum = checksum ^ cmd.charCodeAt(i); + // Make the ‘Advanced’ button a plain button, not a submit button + $('#btnadvgps').prop('type','button'); + + // On click, show the controls in the GPS Initialization section + $("#btnadvgps").click(function() { + hideInput('gpsinitcmd', false); + hideClass('calculator', false); + }); + + // Make the ‘Calculate’ button a plain button, not a submit button + $('#btncalc').prop('type','button'); + $('#result').prop("disabled", true); + + // Onclick read the string from the nmeastring box, calculate the checksum + // and display the results in the result box + $("#btncalc").click(function() { + $('#result').val(NMEAChecksum($('#nmeastring').val())); + }); + + // When the 'GPS' selector is changed, we set tth gps defaults + $('#gpstype').on('change', function() { + set_gps_default($(this).val()); + }); + + hideInput('gpsinitcmd', true); + hideClass('calculator', true); + + set_gps_default('<?=$pconfig['type']?>'); + + // Checkboxes gpsprefer and gpsselect are mutually exclusive + $('#gpsprefer').click(function() { + if ($(this).is(':checked')) { + $('#gpsselect').prop('checked', false); } - // Convert it to hexadecimal (base-16, upper case, most significant byte first). - var hexsum = Number(checksum).toString(16).toUpperCase(); - if (hexsum.length < 2) { - hexsum = ("00" + hexsum).slice(-2); + }); + + $('#gpsselect').click(function() { + if ($(this).is(':checked')) { + $('#gpsprefer').prop('checked', false); } - // Display the result - document.getElementById("nmeachecksum").innerHTML = hexsum; - } + }); +}); //]]> </script> -</head> -<body link="#0000CC" vlink="#0000CC" alink="#0000CC"> -<?php include("fbegin.inc"); ?> -<form action="services_ntpd_gps.php" method="post" name="iform" id="iform" accept-charset="utf-8"> -<?php if ($input_errors) print_input_errors($input_errors); ?> -<?php if ($savemsg) print_info_box($savemsg); ?> - -<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="ntpd gps"> - <tr> - <td> -<?php - $tab_array = array(); - $tab_array[] = array(gettext("NTP"), false, "services_ntpd.php"); - $tab_array[] = array(gettext("Serial GPS"), true, "services_ntpd_gps.php"); - $tab_array[] = array(gettext("PPS"), false, "services_ntpd_pps.php"); - display_top_tabs($tab_array); -?> - </td> - </tr> - <tr> - <td> - <div id="mainarea"> - <table class="tabcont" width="100%" border="0" cellpadding="6" cellspacing="0" summary="main area"> - <tr> - <td colspan="2" valign="top" class="listtopic"><?=gettext("NTP Serial GPS Configuration"); ?></td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq"> - </td> - <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. - <br /> - <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."); ?> - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq"><?=gettext("GPS"); ?></td> - <td width="78%" valign="top" class="vtable"> - <!-- Start with the original "Default", list a "Generic" and then specific configs alphabetically --> - <select id="gpstype" name="gpstype" class="formselect" onchange="set_gps_default(this.form)"> - <option value="Custom"<?php if ($pconfig['type'] == 'Custom') echo " selected=\"selected\""; ?>>Custom</option> - <option value="Default"<?php if ($pconfig['type'] == 'Default') echo " selected=\"selected\""; ?>>Default</option> - <option value="Generic" title="Generic"<?php if ($pconfig['type'] == 'Generic') echo " selected=\"selected\"";?>>Generic</option> - <option value="Garmin" title="$PGRM... Most Garmin"<?php if ($pconfig['type'] == 'Garmin') echo " selected=\"selected\"";?>>Garmin</option> - <option value="MediaTek" title="$PMTK... Adafruit, Fastrax, some Garmin and others"<?php if ($pconfig['type'] == 'MediaTek') echo " selected=\"selected\"";?>>MediaTek</option> - <option value="SiRF" title="$PSRF... Used by many devices"<?php if ($pconfig['type'] == 'sirf') echo " selected=\"selected\"";?>>SiRF</option> - <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> - <option value="SureGPS" title="$PMTK... Sure Electronics SKG16B"<?php if ($pconfig['type'] == 'SureGPS') echo " selected=\"selected\"";?>>SureGPS</option> - </select> - <?php echo gettext("This option allows you to select a predefined configuration.");?> - <br /> - <br /> - <strong><?php echo gettext("Note: ");?></strong><?php echo gettext("Default is the configuration of pfSense 2.1 and earlier"); ?> - <?php echo gettext(" (not recommended). Select Generic if your GPS is not listed.)"); ?><br /> - <strong><?php echo gettext("Note: ");?></strong><?php echo gettext("The perdefined configurations assume your GPS has already been set to NMEA mode."); ?> - </td> - </tr> -<?php - /* Probing would be nice, but much more complex. Would need to listen to each port for 1s+ and watch for strings. */ - $serialports = glob("/dev/cua?[0-9]{,.[0-9]}", GLOB_BRACE); - if (!empty($serialports)): -?> - <tr> - <td width="22%" valign="top" class="vncellreq">Serial port</td> - <td width="78%" class="vtable"> - <select name="gpsport" class="formselect"> - <option value="">none</option> -<?php - foreach ($serialports as $port): - $shortport = substr($port, 5); - $selected = ($shortport == $pconfig['port']) ? " selected=\"selected\"" : ""; -?> - <option value="<?php echo $shortport;?>"<?php echo $selected;?>><?php echo $shortport;?></option> -<?php - endforeach; -?> - </select> - <?php echo gettext("All serial ports are listed, be sure to pick the port with the GPS attached."); ?> - <br /><br /> - <select id="gpsspeed" name="gpsspeed" class="formselect"> - <option value="0"<?php if (!$pconfig['speed']) echo " selected=\"selected\""; ?>>4800</option> - <option value="16"<?php if ($pconfig['speed'] === '16') echo " selected=\"selected\"";?>>9600</option> - <option value="32"<?php if ($pconfig['speed'] === '32') echo " selected=\"selected\"";?>>19200</option> - <option value="48"<?php if ($pconfig['speed'] === '48') echo " selected=\"selected\"";?>>38400</option> - <option value="64"<?php if ($pconfig['speed'] === '64') echo " selected=\"selected\"";?>>57600</option> - <option value="80"<?php if ($pconfig['speed'] === '80') echo " selected=\"selected\"";?>>115200</option> - </select> <?php echo gettext("Serial port baud rate."); ?> - <br /> - <br /> - <?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."); ?> - </td> - </tr> -<?php - endif; -?> - <tr> - <!-- 1 = RMC, 2 = GGA, 4 = GLL, 8 = ZDA or ZDG --> - <td width="22%" valign="top" class="vncellreq">NMEA sentences</td> - <td width="78%" class="vtable"> - <select id="gpsnmea" name="gpsnmea[]" multiple="multiple" class="formselect" size="5"> - <option value="0"<?php if (!$pconfig['nmea']) echo " selected=\"selected\""; ?>>All</option> - <option value="1"<?php if ($pconfig['nmea'] & 1) echo " selected=\"selected\"";?>>RMC</option> - <option value="2"<?php if ($pconfig['nmea'] & 2) echo " selected=\"selected\"";?>>GGA</option> - <option value="4"<?php if ($pconfig['nmea'] & 4) echo " selected=\"selected\"";?>>GLL</option> - <option value="8"<?php if ($pconfig['nmea'] & 8) echo " selected=\"selected\"";?>>ZDA or ZDG</option> - </select><br /> - <?php echo gettext("By default NTP will listen for all supported NMEA sentences. Here one or more sentences to listen for may be specified."); ?> - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">Fudge time 1</td> - <td width="78%" class="vtable"> - <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 /> - <?php echo gettext("Fudge time 1 is used to specify the GPS PPS signal offset");?> (<?php echo gettext("default");?>: 0.0). - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">Fudge time 2</td> - <td width="78%" class="vtable"> - <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 /> - <?php echo gettext("Fudge time 2 is used to specify the GPS time offset");?> (<?php echo gettext("default");?>: 0.0). - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">Stratum</td> - <td width="78%" class="vtable"> - <input name="gpsstratum" type="text" class="formfld unknown" id="gpsstratum" max="16" size="20" value="<?=htmlspecialchars($pconfig['stratum']);?>" /><?php echo gettext("(0-16)");?><br /> - <?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> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">Flags</td> - <td width="78%" class="vtable"> - <table> - <tr> - <td> - <?php echo gettext("Normally there should be no need to change these options from the defaults."); ?><br /> - </td> - </tr> - </table> - <table> - <tr> - <td> - <input name="gpsprefer" type="checkbox" class="formcheckbox" id="gpsprefer" onclick="ToggleOther('gpsprefer', 'gpsselect')"<?php if (!$pconfig['prefer']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("NTP should prefer this clock (default: enabled)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpsselect" type="checkbox" class="formcheckbox" id="gpsselect" onclick="ToggleOther('gpsselect', 'gpsprefer')"<?php if ($pconfig['noselect']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("NTP should not use this clock, it will be displayed for reference only(default: disabled)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpsflag1" type="checkbox" class="formcheckbox" id="gpsflag1"<?php if ($pconfig['flag1']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("Enable PPS signal processing (default: enabled)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpsflag2" type="checkbox" class="formcheckbox" id="gpsflag2"<?php if ($pconfig['flag2']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("Enable falling edge PPS signal processing (default: rising edge)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpsflag3" type="checkbox" class="formcheckbox" id="gpsflag3"<?php if ($pconfig['flag3']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("Enable kernel PPS clock discipline (default: enabled)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpsflag4" type="checkbox" class="formcheckbox" id="gpsflag4"<?php if ($pconfig['flag4']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <span class="vexpl"><?php echo gettext("Obscure location in timestamp (default: unobscured)."); ?></span> - </td> - </tr> - <tr> - <td> - <input name="gpssubsec" type="checkbox" class="formcheckbox" id="gpssubsec"<?php if ($pconfig['subsec']) echo " checked=\"checked\""; ?> /> - </td> - <td> - <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> - </td> - </tr> - </table> - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">Clock ID</td> - <td width="78%" class="vtable"> - <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 /> - <?php echo gettext("This may be used to change the GPS Clock ID");?> (<?php echo gettext("default");?>: GPS). - </td> - </tr> - <tr> - <td width="22%" valign="top" class="vncellreq">GPS Initialization</td> - <td width="78%" class="vtable"> - <div id="showgpsinitbox"> - <input type="button" onclick="show_advanced('showgpsinitbox', 'showgpsinit')" value="<?=gettext("Advanced");?>" /> - <?=gettext("Show GPS Initialization commands");?> - </div> - <div id="showgpsinit" style="display:none"> - <p> - <textarea name="gpsinitcmd" class="formpre" id="gpsinitcmd" cols="65" rows="7"><?=htmlspecialchars(base64_decode($pconfig['initcmd'])); /*resultmatch*/?></textarea><br /> - <?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 /> - <strong><?php echo gettext("NMEA checksum calculator");?>:</strong> - <br /> - <?php echo gettext("Enter the text between "$" and "*" 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> - <input type="button" onclick="NMEAChecksum(nmeastring.value)" value="<?=gettext("Calculate NMEA checksum");?>" /><br /> - </p> - </div> - </td> - </tr> - <tr> - <td width="22%" valign="top"> </td> - <td width="78%"> - <input name="Submit" type="submit" class="formbtn" value="<?=gettext("Save");?>" /> - </td> - </tr> - </table> - </div> - </td> - </tr> -</table> -<script type="text/javascript"> -//<![CDATA[ -set_gps_default(this.form); -//]]> -</script> -</form> -<?php include("fend.inc"); ?> -</body> -</html> + +<?php include("foot.inc");
\ No newline at end of file |
