TrackMyRide Windows Client Setup

Hardware required

At a minimum you will need the following hardware and software

Setup Steps

  1. Setup your computer by attaching a monitor, keyboard and mouse.
  2. Make sure Windows is installed and you can establish a connection to the Internet.
  3. Download the client software (the link above takes you to the latest version of the software).
  4. Unzip (decompress) the files in the archive. We recommend creating a folder named TrackMyRide-Client in the C:\Program Files folder.
  5. Plug the GPS receiver into one of the USB ports of your computer.
  6. Use Device Manager to find the port that your GPS is plugged into.
    • Viewing device manager
  7. Make a note of the value for the COM port. In this example it is COM3. You will need this value later to configure the application's communication port.
  8. Navigate to the folder where the program was installed. Locate the file with the extension .config.
  9. Edit the file with Notepad, Notepad++, or some other similar text editor. (In this example we used Notepad++).
  10. Configuration file
  11. The definitions for each parameter are shown below. We only modify items in the <appSettings> section
  12. COM Port Settings

    • baud_rate - This specifies the speed of the connection from the computer to the GPS receiver. This may vary depending on your GPS receiver. In most cases it should be set to 9600.
    • data_bits - This represents the number of bits (binary digits) returned in one frame of data. This usually is set to 8 bits.
    • handshake - A method used in serial communication to prevent data loss. Can be set to None, RequestToSend, RequestToSendXOnXOff, or XOnXOff. In most cases this should be set to None.
    • parity - A simple method to check for single-bit data errors during serial transmissions. Can be set to Even, Mark, None, Odd, or Space. Since the GPS receiver is connected directly over USB partiy is not necessary. Leave this setting set to None unless your GPS receiver communicates differently.
    • port - Specifies the communications port that the computer uses to communicate with the GPS receiver. This value will be a COMx value, where x represents a number. You used Device Manager above to determine the COM port used.
    • stop_bits - This parameter tells the serial connection how many bits are added to the data bits and specifies the number of bits that signify the end of the frame. Allowed values are: 1 or 2. In most cases the number of stop bits is 1.
  13. Configuration Settings

    • device_id - The id of your device (always a four character value). You must locate the id of your device otherwise you will be reporting data for the wrong device. View this link for information on finding your device id.
    • exception_log - The name of the file where the program puts any error messages.
    • logfile - The name of the file where the program logs all reported data.
    • max_timeout - If using the SmartBeaconing feature this specifies the maximum amount of time (in seconds) the program waits before reporting position date. See this article for more information about SmartBeaconing.
    • min_speed - This specifies the minimum speed the device must be moving before a report is made. Certain GPS devices report a heading change when starting from a dead stop. This prevents the device from making erronous reports. We recommend leaving this setting at 5 (mph).
    • program_name - The display name of the program. This should be left at the default setting.
    • report_timeout - If you are not using SmartBeaconing mode the program will make regular reports at this interval (in seconds).
    • version - The version number of the program. The program uses this value to check for program updates and should not be changed without help from technical support.
  14. Smart Beaconing Settings

    • degree_change_trigger - If SmartBeaconing is active, this value tells the program the number of degrees in heading change that must occur before a report is made. You can set this value to any number between (0 and 360). We recommend setting it to 60.
    • distance_trigger - How far the device must travel before a report is made. Once the device travels this far (in feet) a new report is generated.
    • smart_beaconing - If set to true SmartBeaconing is on. If set to false SmartBeaconing is off and the device reports every x seconds as specified in the report_timeout value above.
  15. UDP Settings

    • udp_port - The UDP port number that the program sends reports to. For testing purposes support might request you to change this number. In all other cases it should be set to 11000.
    • server - The IP address or host name of the UDP server. Unless otherwise requested by support set to udp.trackmyride.us.
  16. MQTT Settings

    • MQTTPassword - The MQTT user's connection password. This password is found in your user's profile. Click here for more information on how to locate your MQTT username and password.
    • MQTTPort - The MQTT port the device uses to communicate with the MQTT server. By default this should be port 1883. Do not change this port unless directed by support.
    • MQTTServer - Hostname of the MQTT server. This is the server your device sends the report data to. Unless directed by support, this should be mqtt.celebrationcomputer.com.
    • MQTTTopic - This is the topic to which the client program publishes. For free account types the topic must be TMR/public/device guid where device guid is the unique id of your device. Click here for help on locating your device's guid.
    • MQTTUsername - All MQTT communications are secured with a username and password. Each device has a unique username and password that is specific to the device. Click here. to see how to find the username and password for your device.
  17. HTTP Settings

    • report_page - Specifies the web page to which the client sends the report data. Unless otherwise specified by support this should be /iot/web-report.aspx.
    • HTTPServer - IP address or host name of the web server to which the reports are being made. Unless other specified by support this should be http://www2.trackmyride.us.
    • HTTPPort - The port number used by the client to communicate with the web server. This should be 80 unless otherwise specified by support.

While most configuration is done in the application configuration file as described above, the program uses command-line parameters to modify the behavior of how the program behaves.

Below are the command-line parameters that can be used with the Windows client software.

Parameter Name Description
/? Help parameter Display information about the available command-line parameters
/r= Report Protocol

If not specified, the program uses MQTT.

/r=h (Causes the client to report using HTTP)

/r=m (Causes the client to report using MQTT)

/r=u (Causes the client to report using UDP)

/s Screen Size

If the user enters /s the program displays the minimal information for the program. If not specified the maximum information read by the program is displayed. In most cases we recommend using the /s parameter.

The /s parameter is ideal for smaller screen devices such as mobile devices.

Running the program

After configuring the file with your parameters, you can create a shortcut or run the program from the command prompt. To run the program type:

gps-reader.exe /s /r=m

Executing the program from the command-prompt

Once the program starts and the GPS "warms" up the user will see the program output. View this page for more information on interpreting the program output.

Important Notes

Configuration file notes:
  • The order of the parameters in the file is not important.
  • You should leave all the sections in the file even if you're not using them. For example if you are reporting data via MQTT leave the HTTP and UDP sections in the file even though the program ignores them.
  • The key parameters are not case sensitive.
  • Usernames and passwords are case-sensitive.
  • Spelling is important.
  • You must use the correct device id and device guids. If you use an incorrect id the system cannot display your device position.
Command-line notes:
  • The order of the parameters is not important.
  • The parameters are not case sensitive.

With TrackMyRide view the location of anyone, anywhere, anytime. It is an open system designed to be highly informative and user friendly. It allows real time tracking and location of your devices. You can also view the history of the device and view its location over a customizable time range.

STAY UP TO DATE
Version: 5.5.24
CONTACT US
Submit a tech support ticket support@trackmyride.us
Icons supplied by Freepik from www.flaticon.com