ntripstreams

class ntripstreams.NtripStream

Bases: object

getHeaderStrings(rawHeader: Union[bytes, list]) str
Parameters

rawHeader ([bytes, list]) – DESCRIPTION.

Returns

DESCRIPTION.

Return type

str

async getNtripResponseHeader() None
Raises

ConnectionError – DESCRIPTION.

Returns

DESCRIPTION.

Return type

None

async getRtcmFrame()
ntripResponseStatusOk() bool
Raises

ConnectionError – DESCRIPTION.

Returns

DESCRIPTION.

Return type

bool

async openNtripConnection(casterUrl: str) bool

Connects to a caster.

Parameters

casterUrl (str) – http[s]://caster.hostname.net:port.

Raises
  • TimeoutError – DESCRIPTION.

  • OSError – DESCRIPTION.

Returns

DESCRIPTION.

Return type

bool

async requestNtripServer(casterUrl: str, mountPoint: str, user: Optional[str] = None, passwd: Optional[str] = None, ntripVersion: int = 2) None
Parameters
  • casterUrl (str) – DESCRIPTION.

  • mountPoint (str) – DESCRIPTION.

  • user (str, optional) – DESCRIPTION. The default is None.

  • passwd (str, optional) – DESCRIPTION. The default is None.

  • ntripVersion (int, optional) –

    DESCRIPTION. The default is 2. : TYPE

    DESCRIPTION.

Returns

DESCRIPTION.

Return type

None

async requestNtripStream(casterUrl: str, mountPoint: str, user: Optional[str] = None, passwd: Optional[str] = None) None
Parameters
  • casterUrl (str) – DESCRIPTION.

  • mountPoint (str) – DESCRIPTION.

  • user (str, optional) – DESCRIPTION. The default is None.

  • passwd (str, optional) – DESCRIPTION. The default is None.

Returns

DESCRIPTION.

Return type

None

async requestSourcetable(casterUrl: str) list
Parameters

casterUrl (str) – DESCRIPTION.

Raises

ConnectionError – DESCRIPTION.

Returns

DESCRIPTION.

Return type

list

async sendRequestHeader() None
Returns

DESCRIPTION.

Return type

None

async sendRtcmFrame(rtcmFrame: bitstring.BitStream) None
setRequestServerHeader(casterUrl: str, ntripMountPoint: str, ntripUser: Optional[str] = None, ntripPassword: Optional[str] = None, ntripVersion: int = 2) None
Parameters
  • casterUrl (str) – DESCRIPTION.

  • ntripMountPoint (str) – DESCRIPTION.

  • ntripUser (str, optional) – DESCRIPTION. The default is None.

  • ntripPassword (str, optional) – DESCRIPTION. The default is None.

  • ntripVersion (int, optional) –

    DESCRIPTION. The default is 2. : TYPE

    DESCRIPTION.

Returns

DESCRIPTION.

Return type

None

setRequestSourceTableHeader(casterUrl: str) None
Parameters

casterUrl (str) – DESCRIPTION.

Returns

DESCRIPTION.

Return type

None

setRequestStreamHeader(casterUrl: str, ntripMountPoint: str, ntripUser: Optional[str] = None, ntripPassword: Optional[str] = None, nmeaString: Optional[str] = None) None
Parameters
  • casterUrl (str) – DESCRIPTION.

  • ntripMountPoint (str) – DESCRIPTION.

  • ntripUser (str, optional) – DESCRIPTION. The default is None.

  • ntripPassword (str, optional) – DESCRIPTION. The default is None.

  • nmeaString (str, optional) –

    DESCRIPTION. The default is None. : TYPE

    DESCRIPTION.

Returns

DESCRIPTION.

Return type

None

class ntripstreams.Rtcm3

Bases: object

constellation(messageType: int)
decodeRtcmFrame(rtcmFrame)
decodeRtcmMessage(message)
encodeRtcmFrame(messageType: int, dataDict)
encodeRtcmMessage(messageType: int, dataDict)
messageDescription(messageType: int)
messageDescriptionText = {1001: 'L1-Only GPS RTK Observables', 1002: 'Extended L1-Only GPS RTK Observables', 1003: 'L1 & L2 GPS RTK Observables', 1004: 'Extended L1 & L2 GPS RTK Observables', 1005: 'Stationary RTK Reference Station ARP', 1006: 'Stationary RTK Reference Station ARP with Antenna Height', 1007: 'Antenna Descriptor', 1008: 'Antenna Descriptor & Serial Number', 1009: 'L1-Only GLONASS RTK Observables', 1010: 'Extended L1-Only GLONASS RTK Observables', 1011: 'L1 & L2 GLONASS RTK Observables', 1012: 'Extended L1 & L2 GLONASS RTK Observables', 1013: 'System Parameters', 1014: 'Network Auxiliary Station Data', 1015: 'GPS Ionospheric Correction Differences', 1016: 'GPS Geometric Correction Differences', 1017: 'GPS Combined Geometric and Ionospheric Correction Differences', 1018: 'RESERVED for Alternative Ionospheric Correction Difference Message', 1019: 'GPS Ephemerides', 1020: 'GLONASS Ephemerides', 1021: 'Helmert / Abridged Molodenski Transformation Parameters', 1022: 'Molodenski-Badekas Transformation Parameters', 1023: 'Residuals, Ellipsoidal Grid Representation', 1024: 'Residuals, Plane Grid Representation', 1025: 'Projection Parameters, Projection Types other than Lambert Conic Conformal (2 SP) and Oblique Mercator', 1026: 'Projection Parameters, Projection Type LCC2SP (Lambert Conic Conformal (2 SP))', 1027: 'Projection Parameters, Projection Type OM (Oblique Mercator)', 1028: '(Reserved for Global to Plate-Fixed Transformation)', 1029: 'Unicode Text String', 1030: 'GPS Network RTK Residual Message', 1031: 'GLONASS Network RTK Residual Message', 1032: 'Physical Reference Station Position Message', 1033: 'Receiver and Antenna Descriptors', 1034: 'GPS Network FKP Gradient', 1035: 'GLONASS Network FKP Gradient', 1037: 'GLONASS Ionospheric Correction Differences', 1038: 'GLONASS Geometric Correction Differences', 1039: 'GLONASS Combined Geometric and Ionospheric Correction Differences', 1042: 'BDS Satellite Ephemeris Data', 1044: 'QZSS Ephemerides', 1045: 'Galileo F/NAV Satellite Ephemeris Data', 1046: 'Galileo I/NAV Satellite Ephemeris Data', 1057: 'SSR GPS Orbit Correction', 1058: 'SSR GPS Clock Correction', 1059: 'SSR GPS Code Bias', 1060: 'SSR GPS Combined Orbit and Clock Corrections', 1061: 'SSR GPS URA', 1062: 'SSR GPS High Rate Clock Correction', 1063: 'SSR GLONASS Orbit Correction', 1064: 'SSR GLONASS Clock Correction', 1065: 'SSR GLONASS Code Bias', 1066: 'SSR GLONASS Combined Orbit and Clock Corrections', 1067: 'SSR GLONASS URA', 1068: 'SSR GLONASS High Rate Clock Correction', 1070: 'Reserved MSM', 1071: 'GPS MSM1', 1072: 'GPS MSM2', 1073: 'GPS MSM3', 1074: 'GPS MSM4', 1075: 'GPS MSM5', 1076: 'GPS MSM6', 1077: 'GPS MSM7', 1078: 'Reserved MSM', 1079: 'Reserved MSM', 1080: 'Reserved MSM', 1081: 'GLONASS MSM1', 1082: 'GLONASS MSM2', 1083: 'GLONASS MSM3', 1084: 'GLONASS MSM4', 1085: 'GLONASS MSM5', 1086: 'GLONASS MSM6', 1087: 'GLONASS MSM7', 1088: 'Reserved MSM', 1089: 'Reserved MSM', 1090: 'Reserved MSM', 1091: 'Galileo MSM1', 1092: 'Galileo MSM2', 1093: 'Galileo MSM3', 1094: 'Galileo MSM4', 1095: 'Galileo MSM5', 1096: 'Galileo MSM6', 1097: 'Galileo MSM7', 1098: 'Reserved MSM', 1099: 'Reserved MSM', 1100: 'Reserved MSM', 1101: 'SBAS MSM1', 1102: 'SBAS MSM2', 1103: 'SBAS MSM3', 1104: 'SBAS MSM4', 1105: 'SBAS MSM5', 1106: 'SBAS MSM6', 1107: 'SBAS MSM7', 1108: 'Reserved MSM', 1109: 'Reserved MSM', 1110: 'Reserved MSM', 1111: 'QZSS MSM1', 1112: 'QZSS MSM2', 1113: 'QZSS MSM3', 1114: 'QZSS MSM4', 1115: 'QZSS MSM5', 1116: 'QZSS MSM6', 1117: 'QZSS MSM7', 1118: 'Reserved MSM', 1119: 'Reserved MSM', 1120: 'Reserved MSM', 1121: 'BeiDou MSM1', 1122: 'BeiDou MSM2', 1123: 'BeiDou MSM3', 1124: 'BeiDou MSM4', 1125: 'BeiDou MSM5', 1126: 'BeiDou MSM6', 1127: 'BeiDou MSM7', 1128: 'Reserved MSM', 1129: 'Reserved MSM', 1130: 'Reserved MSM', 1131: 'IRNSS MSM1 (Experimental, not implemented)', 1132: 'IRNSS MSM2 (Experimental, not implemented)', 1133: 'IRNSS MSM3 (Experimental, not implemented)', 1134: 'IRNSS MSM4 (Experimental, not implemented)', 1135: 'IRNSS MSM5 (Experimental, not implemented)', 1136: 'IRNSS MSM6 (Experimental, not implemented)', 1137: 'IRNSS MSM7 (Experimental, not implemented)', 1138: 'Reserved MSM (Experimental)', 1139: 'Reserved MSM (Experimental)', 1140: 'Reserved MSM (Experimental)', 1230: 'GLONASS L1 and L2 Code-Phase Biases'}
mjd(unixTimestamp)
msmConstellation(messageType: int)
msmSignalTypes(messageType: int, msmSignals)
ntripstreams.crc24q(data)

Calculate Qualcomm 24 bit cyclic redundancy check

Return type

Qualcomm 24 bit crc remainder (checksum)

ntripstreams.crcNmea(data)