initial commit

README.md

@@ -0,0 +1,4 @@
+# t4koptions
+
+This is a command line utility that can be used to generate option enable codes
+for a yellow box Trimble 4000 series receiver.

main.go

@@ -0,0 +1,228 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+)
+
+func main() {
+
+	var serial, option, value int
+	var valueStr string
+	var listOptions bool
+
+	flag.BoolVar(&listOptions, "l", false, "list options and exit")
+	flag.IntVar(&serial, "s", 0, "serial number of receiver")
+	flag.IntVar(&option, "o", 0, "option number (use -l to list)")
+	flag.StringVar(&valueStr, "v", "", "option value in hex (typically 00 = enable, FF = disable)")
+
+	flag.Parse()
+
+	if listOptions {
+		for i, name := range optionNames {
+			if name == "" {
+				continue
+			}
+			fmt.Printf("Option %2d = %s\n", i, name)
+		}
+		os.Exit(0)
+	}
+
+	if serial == 0 || option == 0 || valueStr == "" {
+		flag.PrintDefaults()
+		os.Exit(1)
+
+	}
+
+	if option < 0 || option > 59 {
+		fmt.Printf("Option number %d is out of range (allowed: 0-59)\n", option)
+		os.Exit(1)
+	}
+
+	n, err := fmt.Sscanf(valueStr, "%2x", &value)
+
+	if n == 0 || err != nil {
+		fmt.Println("Unable to parse option value.")
+		os.Exit(1)
+	}
+
+	e := encrypt(serial, option, value)
+
+	fmt.Printf("Receiver Serial Number: %d\n", serial)
+	if option < len(optionNames) {
+		fmt.Printf("Option Number: %d (%s)\n", option, optionNames[option])
+	} else {
+		fmt.Printf("Option Number: %d (out of range)\n", option)
+	}
+	fmt.Printf("Option Value: %02X\n", value)
+	fmt.Printf("Code: %s\n", e)
+
+	return
+
+}
+
+func encrypt(serialNumber, feature, value int) string {
+
+	passwordStr := fmt.Sprintf("%05d%02d%02X", serialNumber, feature, value)
+
+	password := []byte(passwordStr)
+
+	fromASCII(password)
+
+	sn := byte(serialNumber) & 0xF
+	secret := []byte{7, 7, 5, 5, 9, 8, 1, 4, 2}
+
+	encrypted := make([]byte, 10)
+
+	for x := 0; x < 9; x++ {
+		encrypted[8-x] = sn ^ secret[8-x] ^ reverseBits(password[x])
+	}
+
+	encrypted[9] = calculateCheck(encrypted)
+
+	toASCII(encrypted)
+
+	return string(encrypted)
+
+}
+
+func decrypt(serialNumber int, passwordStr string) (int, int, int, error) {
+
+	if len(passwordStr) != 10 {
+		return 0, 0, 0, fmt.Errorf("password must be 10 characters long")
+	}
+	password := []byte(passwordStr)
+
+	fromASCII(password)
+
+	sum := calculateCheck(password)
+	if password[9] != sum {
+		return 0, 0, 0, fmt.Errorf("bad checksum")
+	}
+
+	sn := byte(serialNumber) & 0xF
+	secret := []byte{7, 7, 5, 5, 9, 8, 1, 4, 2}
+
+	decrypted := make([]byte, 9)
+
+	for x := 0; x < 9; x++ {
+		decrypted[8-x] = reverseBits(sn ^ secret[x] ^ password[x])
+	}
+
+	toASCII(decrypted)
+
+	var serial, option, value int
+
+	_, err := fmt.Sscanf(string(decrypted), "%5d%2d%2X", &serial, &option, &value)
+	if err != nil {
+		return 0, 0, 0, err
+	}
+	return serial, option, value, nil
+
+}
+
+func calculateCheck(password []byte) byte {
+	sum := 0
+
+	for i := 8; i >= 0; i-- {
+		for j := 3; j >= 0; j-- {
+			sum += int(password[i]) >> j & 1
+		}
+	}
+
+	return byte(sum & 0xF)
+}
+
+func reverseBits(in byte) byte {
+	var out byte
+	for i := 0; i < 4; i++ {
+		if in&(1<<i) != 0 {
+			out |= 1 << (3 - i)
+		}
+	}
+	return out
+}
+
+func fromASCII(s []byte) {
+	for i, b := range s {
+		if b > '9' {
+			s[i] -= '7'
+		} else {
+			s[i] -= '0'
+		}
+	}
+}
+
+func toASCII(s []byte) {
+	for i, b := range s {
+		if b > 9 {
+			s[i] += '7'
+		} else {
+			s[i] += '0'
+		}
+	}
+}
+
+var optionNames = []string{
+	"POWER UP PORT SETTINGS",
+	"POWER UP OUTPUT MSGS",
+	"LOCATOR",
+	"POWER UP NV ERASE",
+	"RTCM ASCII",
+	"CYCLE PRINT",
+	"POSITION STATISTICS",
+	"TAILBOUY",
+	"PATHFINDER",
+	"LANDSEIS",
+	"RTCM NETWORK INPUT",
+	"CARRIER PHASE",
+	"HALF CYCLE L2",
+	"MAXWELL L1 ONLY",
+	"REMOTE DOWNLOAD",
+	"DEMO EQUIPMENT ONLY",
+	"",
+	"RT SURVEY DATA",
+	"LOCAL DATUMS",
+	"RSIM INTERFACE",
+	"DUAL FREQ / MULTI-BIT",
+	"RS-232 PORTS",
+	"MULTIPLE DATUMS",
+	"EXTERNAL TIMEBASE",
+	"EVENT MARKER",
+	"1 PPS",
+	"",
+	"FIRMWARE UPDATE",
+	"RTCM INPUTS",
+	"RTCM OUTPUTS",
+	"SYNC INTERVAL",
+	"NMEA-0183",
+	"SV SWAPPING",
+	"KEYBOARD TYPE",
+	"NAVIGATION",
+	"LctrCrPh",
+	"KINEMATIC",
+	"CONFIGURED",
+	"DATA LOGGING SIZE",
+	"SURVEY TYPE",
+	"RTK OTF CAPABILITIES",
+	"IONO-FREE POSITIONING",
+	"",
+	"I/O DRIVERS",
+	"",
+	"CMR TYPE2 RATE",
+	"RTK SPECIALS",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+	"",
+}

options.txt

@@ -0,0 +1,153 @@
+These are the known option codes and their names. The names have been
+extracted from receiver firmware, and may not exist on your firmware
+version. The descriptions have been extracted from various sources,
+including Trimble marketing material.
+
+00: POWER UP PORT SETTINGS
+
+01: POWER UP OUTPUT MSGS
+
+02: LOCATOR OPERATION
+
+03: POWER UP NV ERASE
+
+04: RTCMAsci
+
+05: CyclPrnt
+
+06: POSITION STATISTICS
+
+	Enables a receiver to compute the probable error (“sigma”) in its
+	real- time position fixes.
+
+07: TAILBOUY
+
+	Elsewhere in the firmware this is parsed as 'LOW BATTERY OVERRIDE'.
+	I don't know what either of these mean.
+
+08: PATHFINDER
+
+09: LandSeis
+
+10: RTCM NETWORK INPUT
+
+11: CARRIER PHASE
+
+	Enables a receiver to measure satellite range by observing (among
+	other things) the phase difference between the L1 and L2 carriers.
+	This option is less precise than the L2 P-Code Option, but it is not
+	affected by Anti-Spoofing. It may be used as a less sophisticated
+	alternative to the L2 P-Code Option, or as a fallback when Anti-
+	Spoofing is active.
+
+12: HALF CYCLE L2
+
+	A technique for correcting ionospheric delay errors without the use of
+	P-code; replaced in recent dual-frequency receivers by the more
+	accurate Cross-Correlation Option.
+
+13: MAXWELL L1 ONLY
+
+14: REMOTE DOWNLOAD
+
+	Enables a computer equipped with a modem to download data files from
+	an unattended receiver.
+
+15: DEMO EQUIPMENT ONLY
+
+17: RT SURVEY DATA
+
+18: LOCAL DATUMS
+
+19: RSIM INTERFACE
+
+20: DUAL FREQ / MULTI-BIT
+
+21: RS-232 PORTS
+
+	The number of RS-232 ports installed in the
+	receiver. Two ports are built in, two additional ports can be
+	installed with additional hardware.
+
+22: MULTIPLE DATUMS
+
+23: EXTERNAL TIMEBASE
+
+	Enables a receiver to substitute a very precise external oscillator,
+	such as an atomic clock, for its internal quartz-crystal oscillator.
+	The EXT-REF BNC jack is only populated on CORS receivers, so enabling
+	this option without the appropriate jack is pointless.
+
+24: EVENT MARKER
+
+	Enables a receiver to log a time-stamped record whenever an event (an
+	electrical pulse) is detected on a special connector. You can record
+	alphanumeric messages associated with particular events; you can also
+	generate events from the receiver's keypad.
+
+25: 1 PPS
+
+	Provides a port through which the receiver can output a very precise
+	one pulse/second strobe, based on timing information in the satellite
+	signals. Other devices can use this strobe as a timing signal.
+
+27: FIRMWARE UPDATE
+
+28: RTCM INPUTS
+
+	Enables a receiver to serve as a DGPS differential station (a rover)
+	by inputting RTCM-104 corrections through a serial port from a digital
+	radio receiver.
+
+29: RTCM OUTPUTS
+
+	Enables a receiver to function as a DGPS reference station (a base
+	station) by outputting RTCM-104 corrections through a serial port to a
+	digital radio transmitter.
+
+30: SYNC INTERVAL
+
+	Interval between successive measurements in seconds.
+
+31: NMEA-01
+
+	Enables a receiver to output several types of NMEA-0183 messages
+	through a serial port. Other devices can use these messages for
+	navigation and similar functions. This option is used primarily in
+	marine applications.
+
+32: SV SWAPPING
+
+33: KEYBOARD TYPE
+
+34: NAVIGATION
+
+	Provides an extended set of navigation functions, including a cross-
+	track error display and the ability to define and use up to 99
+	waypoints.
+
+35: LOCATOR CAR. PHASE
+
+36: KINEMATIC
+
+	Enables a receiver to perform kinematic surveys.
+
+37: Config'd
+
+38: DATA LOGGING SIZE
+
+39: SURVEY TYPE
+
+40: RTK OTF CAPABILITIES
+
+41: IONO-FREE POSITIONING
+
+43: I/O DRIVERS
+
+	Described elsewhere in firmware as JX-1100A DRIVER, presumably the
+	Clarion JX-1100A, an early 2.4 GHz spread-spectrum radio modem. This
+	option seems to enable the radio config menu in the MODIFY menu.
+
+45: CMR TYPE2 RATE
+
+46: RTK SPECIALS