Difference between revisions of "RTCM Client"
|Line 152:||Line 152:|
The VOTER/RTCM firmware supports some additional debugging information that can be turned on.
The VOTER/RTCM firmware supports some additional debugging information that can be turned on.
Revision as of 17:27, 9 August 2017
The Micro-Node RTCM and VOTER interfaces are typically used with AllStar in voting/simulcast applications. They MAY be used for ANY repeater interface application, through the chan/voter channel driver.
The VOTER is the original through-hole board designed by Jim Dixon for this application. It is open-source, and the relevant Gerber files and BoM to build it are available.
The Micro-Node Radio Thin Client Module (RTCM) is the commercial version of the VOTER. It uses surface mount parts (SMT), but is functionally equivalent to the original VOTER.
In general, the two terms (RTCM/VOTER) are used interchangeably, as they operate the same, and use the same firmware (mostly, see below).
This page will highlight some of the operational concerns, quirks, bugs, and other items of interest that relate to these interfaces. Much of the information has been gleaned off the AllStar mail list, comes from personal experience, or comes from notes in the firmware source code.
- 1 Firmware
- 2 DSP/BEW Firmware Version
- 3 Chuck Squelch
- 4 RTCM/VOTER LED's
- 5 Debug Options
- 6 TX Level Setting
- 7 GPS
- 8 Ubiquity ToS
The firmware in the RTCM and VOTER is the same, except it is compiled for the specific dsPIC that is installed in each. As such, the firmware is specific to the VOTER or the RTCM, and is NOT interchangeable (it won't boot in the wrong device). Firmware for the RTCM is denoted by "smt" in the filename.
The VOTER uses a dsPIC33FJ128GP802 and the RTCM uses a dsPIC33FJ128GP804.
There are two parts to the firmware, a bootloader, and then the actual firmware file. The bootloader starts when power is applied, and allows you to talk to the dsPIC and load new firmware files over ethernet. If the bootloader is not intercepted by the loading tool, it will continue to boot the current firmware file.
All new boards will need to have the bootloader installed first, followed by a firmware file. You can load a firmware file directly (.hex) in to the dsPIC, but then you will not have any of the bootloader remote loading features.
The current bootloader (.cof file) is available here: https://github.com/AllStarLink/voter/tree/master/voter-bootloader (the -smt file is for the RTCM). It needs to be loaded with a PICKit programmer.
Current firmware (.cry file) is available here: https://github.com/AllStarLink/voter/tree/master/board-firmware . They are loaded with the EBLEX C30 Programmer.
There are multiple "flavors" of firmware available. See below for further explanation of what all the options mean.
The DSPBEW versions have Jim's DSP/BEW feature enabled. Note that due to the size of this feature, the diagnostics menu is NOT available in this version.
The CHUCK versions have Chuck Henderson's RSSI and Squelch modifications enabled. This is probably the version that most user's will want to use in production.
If you look in the votersystem.pdf, you will find a procedure to modify and load the bootloader in to the dsPIC of a VOTER board.
Unfortunately, there is an important step missing in that procedure, which is covered below.
In addition, the old links for the MPLAB software are dead, so let's update this info and get you going.
Currently (Feb 2017), you can get the required software from:
Download MPLAB IDE 32-bit Windows v8.66:
Download MPLAB C Compiler for PIC24 and dsPIC DSCs v3.31 NOT v.3.25:
Optionally, install Windows Virtual PC and XP Mode. This is getting to be pretty old software, so running it under XP Mode may be a good idea, so we can keep it isolated (install it in a virtual machine). It does run fine in Windows 7.
To setup the compile/build environment, follow these steps:
- Run the MPLAB IDE installer. You don't need to install the HI-TECH C Compiler at the end (click no)
- Run the MPLAB C Compiler installer
- Select Legacy Directory Name
- Select Lite Compiler
- Go to: https://github.com/AllStarLink
- Follow the links to: voter --> Clone or Download --> Download Zip. That will get you voter-master.zip which is a download of the whole VOTER tree from GitHub.
- Extract it somewhere (ie. in the XP Mode Virtual PC)
- Launch the MPLAB IDE
- Go to Configure --> Settings --> Projects and de-select one-to-one project mode.
If you need to load the bootloader in to a fresh board, you will need to follow these steps:
- Go to Project --> Open --> voter-bootloader.mcp --> Open (it is in the voter-bootloader folder of the GitHub source)
- Go to File --> Import --> voter-bootloader --> ENC_C30.cof --> Open This step is missing from the original procedure.
- Remove JP7 on the VOTER Board. This is necessary to allow programming by the PICKit2/PICKit3 device.
- Attach the PICKIT2/PICKit3 device to J1 on the VOTER board. Note that Pin 1 is closest to the power supply modules (as indicated on the board).
- If you have not already selected a programming device, go to Programmer --> Select Device and choose PICKit3 (or PICKit2, depending on what you are using).
- Go to Programmer --> Program. This will program the bootloader firmware into the PIC device on the board.
If you want to change the default IP address from 192.168.1.11 in the bootloader:
- Select View --> Program Memory (from the top menu bar)
- Hit Control-F (to "find") and search for the digits "00A8C0".
- These should be found at memory address "03018".
The "A8C0" at 03018 represents the hex digits C0 (192) and A8 (168) which are the first two octets of the IP address. The six digits to enter are 00 then the SECOND octet of the IP address in hex then the FIRST octet of the IP address in hex.
The "0B01" at 0301A represents the hex digits 0B (11) and 01 (1) which are the second two octets of the IP address. The six digits to enter are 00 then the FOURTH octet of the IP address in hex then the THIRD octet of the IP address in hex.
Once you have modified the address to your desired IP, follow the programming procedure (above).
To compile the firmware (if you want to make custom changes):
- Go to Project --> Open --> navigate to board-firmware and open the .mcp file for the flavor of firmware you want to compile. They are in the board-firmware folder of the GitHub source.
- NOTE: the .mcp files with the "smt" suffix are for the RTCM (built with SMT parts). The non-smt files are for the ORIGINAL through-hole VOTER boards. The difference is that the VOTER uses a dsPIC33FJ128GP802 and the RTCM uses a dsPIC33FJ128GP804.
- Go to Project --> Build Configuration and select "Release". This may not be necessary (I don't believe that option is used in the firmware), but it removes the compiler option of __DEBUG being passed, so theoretically it would build "normal" firmware.
- Go to Configure --> Select Device and choose the appropriate device for your board from the Device list. If you don't select the right one, the board will not boot. Select dsPIC33FJ128GP802 for the VOTER, and dsPIC33FJ128GP804 for the RTCM.
- Now, if you go to Project --> Build All it should compile everything and show you "Build Succeeded".
A .cry file should be in the board-firmware folder. You can load this with the ENC Loader.
There is also a .hex file in there that you could load with a programmer... but that would wipe the bootloader... so don't do that.
If you want to enable "Chuck Squelch", open the HardwareProfile.h and un-comment #define CHUCK.
You may also want to go down to Line 291 in Voter.c (right click on the window, go to Properties --> "C" File Types --> Line Numbers) and tack on CHUCK after 1.60 (the current version number) so that when you load this firmware, the version will be shown as 1.51CHUCK, and you'll know that Chuck Squelch is compiled in. We should probably make that more automagic in the future...
If you want to compile the DSPBEW version, open the DSPBEW project file instead.
DSP/BEW Firmware Version
DSP BEW Firmware is mutually exclusive with the diagnostic menu. There is not enough space for both, if you load the DSP/BEW firmware, you will NOT have a diag menu.
BEW stands for Baseband Examination Window.
Typically, the discriminator of an FM communications receiver produces results containing audio spectrum from the "sub-audible" range (typically < 100 Hz) to well above frequencies able to be produced by modulating audio. These higher frequencies can be utilized to determine signal quality, since they can only contain noise (or no noise, if a sufficiently strong signal is present).
For receivers (such as the Motorola Quantar, etc) that do not provide sufficient spectral content at these "noise" frequencies (for various reasons), The "DSP/BEW (Digital Signal Processor / Baseband Examination Window)" feature of the RTCM firmware may be utilized.
These receivers are perfectly capable of providing valid "noise" signal with no modulation on the input of the receiver, but with strong modulation (high frequency audio and high deviation), it severely interferes with proper analysis of signal strength.
This feature provides a means by which a "Window" of baseband (normal audio range) signal is examined by a DSP and a determination of whether or not sufficient audio is present to cause interference of proper signal strength is made. During the VERY brief periods of time when it is determined that sufficient audio is present to cause interference, the signal strength value is "held" (the last valid value previous to the time of interference) until such time that the interfering audio is no longer present.
The DSP/BEW feature is selectable, and should not be used for a receiver that does not need it.
A note on the Motorola SLR5700 per VE7FET. DSP/BEW definitely makes a difference on what AllMon reports for the signal strength of received signals. It is less reactive when DSP/BEW = 1 than with it set to 0. We'll have to see what the real world trials show. It might be better to leave it off.
"Chuck Squelch" are a couple firmware changes made by Chuck Henderson, WB9UUS.
Pre-compiled firmware versions including this option are available on GitHub. See above on how it is enabled/compiled, if you are rolling your own firmware modifications.
One of the changes fixes an issue with weak signals producing RSSI readings all over the place. It is caused by a 16 bit value that was overflowing (it is the RSSI change in the firmware). It results in rock-solid RSSI values being reported, even on barely or non-readable signals. This change will likely be rolled in to a permanent fix in a future firmware release.
The other firmware change changes how the squelch responds (looks at the noise in the last two audio samples) and makes the "Micor squelch" action work better.
You may also want to consider the following changes in /etc/asterisk/voter.conf:
;Comment out: ;thresholds = ;and set: linger = 0
- If anyone is off frequency a little bit, that will make the voice talk off worse. Double check that the repeater and the users are all on frequency.
- Don't use narrow bandwidth on the repeater receiver.
- Make sure that the discriminator audio is not rolled off even a little bit at the high end. There should not be resistors in series or capacitors to ground between the discriminator chip output pin and the voter board input, for best results.
RX LED on the RTCM/VOTER will flash (same rate as ACT LED) if you have External CTCSS enabled, and the received signal has the wrong (or no) valid PL.
The VOTER/RTCM firmware supports some additional debugging information that can be turned on.
From the source code, the different Debug Options are listed as:
1 - Alt/Main Host change notifications 2 - Ignore HWlock (GGPS only) 4 - GPS/PPS Failure simulation (GGPS only) 8 - POCSAG H/W output disable (GGPS only) 16 - IP TOS Class for Ubiquiti 32 - GPS Debug 64 - Fix GPS 1 second off 128 - Fix GPS 1 month off (WTF,O??)
Not sure what they all do, but that is what they are. Here are the most common ones used:
- "Alt/Main Host change notifications" shows when the connection to the Asterisk server changes state.
- "IP TOS Class for Ubiquity" marks the IP headers from the RTCM/VOTER TO the network with ToS C0/DSCP 48 (UBNT shows this as 802.1p Class 6 (Voice <10mS
latency). Other sources show this as a Network Control TOS.) If you enable this, you also will want to have "utos=y" in your voter.conf to mark the packets from the network TO the RTCM/VOTER. We will probably change this option to mark the packets by default in a future version.
- "GPS Debug" will print NMEA or TSIP debug strings from the connected GPS.
The way this works is you add together the options you want to enable.
Want to enable GPS Debug and IP ToS, set debug to 48.
Just want to turn on GPS Debug, set debug to 32.
Just want ToS turned on, set debug to 16.
TX Level Setting
- Send 1kHz@3kHz on-channel in to the RX
- Set the RX up so it reads 3kHz deviation on the RTCM's built in console meter
- Now set the TX level pot to get 3kHz out of the transmitter (No PL)
Now change the modulation from 1kHz tone to 800Hz followed by 1.8kHz and verify that the deviation level doesn't change as the tone frequency changes. Changing levels indicates a pre/de-emphasis issue.
If using PL you have to account for that deviation, unless you filter it out with your IFR (test set).
The RTCM/VOTER will work with most GPS available. It requires either NMEA or Trimble TSIP binary data. It only receives data from the GPS (GPS TX), it does not send anything to the GPS.
The firmware is specifically written to talk to Trimble Thunderbolt receivers using Trimble's TSIP binary data interface, however, other Trimbles GPS receivers that talk TSIP are generally compatible.
If you are using an NMEA GPS (as opposed to a Trimble using the TSIP binary interface), the RTCM/VOTER is looking for the following NMEA sentences:
$GPGGA $GPGSV $GPRMC
The GPS led will go solid regardless of the connection LED. That has to happen or it won't connect to the Asterisk server.
It is not unusual for it to take up to 20 mins to get a GPS lock LED (ie. using a Trimble Thunderbolt) after any reboot.
If you are having odd loss of lock issues, consider you may have interference to your GPS antenna from strong RF nearby. A note from Jesse Lloyd:
I also had crazy problems with poor signal on my GPS when I set it up sitting in a window, and once installed at site I had the GPS antenna maybe 6 ft from the VHF antenna, and after some troubleshooting found it was getting swamped with RF and loosing lock. I found the debug setting of 32 useful in the RTCM, you can see a hex output of the GPS status.
You may find your Trimble Thunderbolt is showing the incorrect date at the moment. It could be showing the year as 1997. This is due to the date in the Thunderbolt being reported incorrectly.
This can cause some of your voting receivers to not connect, if they are used with other GPS in your system. If you have ALL Thunderbolts, or NO Thunderbolts, you are probably fine. If you have ALL Thunderbolts, the date/time is probably wrong, but they will ALL be wrong, so they will connect.
GPS Time is a continuous counting time scale beginning at the January 5, 1980 to January 6, 1980 midnight. It is split into two parts: a time of week measured in seconds from midnight Sat/Sun and a week number. The time of week is transmitted in an unambiguous manner by the satellites, but only the bottom 10 bits of the week number are transmitted. This means that a receiver will see a week number count that goes up steadily until it reaches 1023 after which it will “roll over” back to zero, before steadily going up again. Such a week rollover will occur approx. every 20 years. The last week rollover occurred in 1999 and the next one will be in 2019.
The Thunderbolt manual states:
The ThunderBolt adjusts for this week rollover by adding 1024 to any week number reported by GPS which is less than week number 936 which began on December 14, 1997. With this technique, the ThunderBolt will provide an accurate translation of GPS week number and TOW to time and date until July 30, 2017.
As such, the Trimble Thunderbolt has a firmware issue with the GPS Week rollover that manifested itself on July 30, 2017, causing the date to become incorrect.
We have added a brute-force fix starting in RTCM/VOTER firmware >=1.51. It fixes the Thunderbolts, we have not done extensive testing to see how it affects other TSIP receivers.
Garmin 18x LVC Wiring Issues
If you have issues with your GPS 18x LVC not talking to the RTCM/VOTER, it may not be hooked up to the RTCM correctly.
The Garmin pin labeling is backwards to what you may think. See below. You probably need to swap pins 6 and 14.
RTCM GPS 18x LVC 6 GRX <-- Rx Data 6 Green 7 GPPS <-- Pulse Output 1 Yellow 8 GND Ground 3 Black 8 GND Ground 5 Black 13 +5V -->Vin 2 Red 14 GTX --> TX Data 4 White
Log into the RTCM and do 98 and you should see something like this:
Current Time: Sun Apr 20, 2014 04:37:02.820 Last Rx Pkt System time: 04/20/2014 03:55:35.580, diff: 2487260 msec Last Rx Pkt Timestamp time: 04/20/2014 03:55:32.064, diff: 3515 msec Last Rx Pkt index: 160, inbounds: 1
Garmin and the RTCM
Beware when buying newer Garmin GPS's to use with the Micro-Node RTCM.
The RTCM expects a 5V PPS signal.
Newer Garmin's (GPS 18X, 18X LVC, etc.) MAY NOT output 5V, and can cause issues. Check the Garmin datasheet.
The VOTER is designed to accept both 3.3V or 5V signals, and should work fine.
No GPS/Mixed Mode
You do not need a timing source to use an RTCM if you don’t want to vote. That’s called Mix Mode.
Having the PPS Polarity set to 2 tells the RTCM you do not have a GPS. That forces the RTCM to become a mix (non-voting) client. Turn it on, save it, and restart. A simple voter.conf would look like this:
[general] port = 667 password = BLAH  Site1 = pswrd1,master,transmit Site2 = pswrd2,transmit
Mixed Client Error
"I am getting this error in Asterisk":
WARNING: chan_voter.c:4511 voter_reader: Voter client master timing source mobile1 attempting to authenticate as mix client!!
A mixed client error means the voter.conf file is expecting an RTCM to try and connect with a GPS IP packet (ie. has master in it in voter.conf), but the RTCM isn't sending a GPS IP packet. So its a mismatch between voter.conf and Option 10 in the RTCM.
If you want to use a mix client (non-voted), make sure that receiver's configuration line in voter.conf does not have the master option set.
To turn on GPS Debugging, set the Debug Option Level in the RTCM/VOTER to 32.
See #Debug Option levels for more information on how this works.
So, if we set ToS/DSCP in the header to C0, then Ubiquity (and other gear watching ToS) should prioritize the packets. This sets the DSCP to 110 000 aka 48. UBNT shows this as 802.1p Class 6 (Voice <10mS latency). Other sources show this as a Network Control TOS.
There is an option in voter.conf to turn this on (utos=y). However, this only controls packets being sent from Asterisk TO the RTCM.
If you want to tag packets from the RTCM TO Asterisk, you need to set the RTCM debug option level to 16 (see #Debug Options for how this works).
At some point we should probably change the default behaviour of the RTCM firmware to mark the packets and use the debug setting to disable ToS. That change (if you wanted to compile your own firmware) would be:
Change line 90 in IP.c From: #define IP_SERVICE ((AppConfig.DebugLevel & 16) ? 0xc0 : (IP_SERVICE_ROUTINE | IP_SERVICE_N_DELAY)) To: #define IP_SERVICE ((AppConfig.DebugLevel & 16) ? (IP_SERVICE_ROUTINE | IP_SERVICE_N_DELAY) : 0xc0)
This changes the conditional expression from if the debug level is 16 to mark the packets with DSCP 48 to if the debug level is 16, mark the packets routine (DSCP 0).