Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
ntrip_client.ntrip_client.NTRIPClient Class Reference

Public Member Functions

def __init__ (self, host, port, mountpoint, ntrip_version, username, password, logerr=logging.error, logwarn=logging.warning, loginfo=logging.info, logdebug=logging.debug)
 
def connect (self)
 
def disconnect (self)
 
def reconnect (self)
 
def recv_rtcm (self)
 
def send_nmea (self, sentence)
 
def shutdown (self)
 

Public Attributes

 ca_cert
 
 cert
 
 key
 
 nmea_parser
 
 reconnect_attempt_max
 
 reconnect_attempt_wait_seconds
 
 rtcm_parser
 
 rtcm_timeout_seconds
 
 ssl
 

Static Public Attributes

int DEFAULT_RECONNECT_ATEMPT_WAIT_SECONDS = 5
 
int DEFAULT_RECONNECT_ATTEMPT_MAX = 10
 
int DEFAULT_RTCM_TIMEOUT_SECONDS = 4
 

Private Member Functions

def _form_request (self)
 
def _socket_is_open (self)
 

Private Attributes

 _basic_credentials
 
 _connected
 
 _first_rtcm_received
 
 _host
 
 _logdebug
 
 _logerr
 
 _loginfo
 
 _logwarn
 
 _mountpoint
 
 _nmea_send_failed_count
 
 _nmea_send_failed_max
 
 _ntrip_version
 
 _port
 
 _raw_socket
 
 _read_zero_bytes_count
 
 _read_zero_bytes_max
 
 _reconnect_attempt_count
 
 _recv_rtcm_last_packet_timestamp
 
 _server_socket
 
 _shutdown
 
 _ssl_context
 

Detailed Description

Definition at line 26 of file ntrip_client.py.

Constructor & Destructor Documentation

◆ __init__()

def ntrip_client.ntrip_client.NTRIPClient.__init__ (   self,
  host,
  port,
  mountpoint,
  ntrip_version,
  username,
  password,
  logerr = logging.error,
  logwarn = logging.warning,
  loginfo = logging.info,
  logdebug = logging.debug 
)

Definition at line 33 of file ntrip_client.py.

Member Function Documentation

◆ _form_request()

def ntrip_client.ntrip_client.NTRIPClient._form_request (   self)
private

Definition at line 294 of file ntrip_client.py.

◆ _socket_is_open()

def ntrip_client.ntrip_client.NTRIPClient._socket_is_open (   self)
private

Definition at line 307 of file ntrip_client.py.

◆ connect()

def ntrip_client.ntrip_client.NTRIPClient.connect (   self)

Definition at line 93 of file ntrip_client.py.

◆ disconnect()

def ntrip_client.ntrip_client.NTRIPClient.disconnect (   self)

Definition at line 168 of file ntrip_client.py.

◆ reconnect()

def ntrip_client.ntrip_client.NTRIPClient.reconnect (   self)

Definition at line 188 of file ntrip_client.py.

◆ recv_rtcm()

def ntrip_client.ntrip_client.NTRIPClient.recv_rtcm (   self)

Definition at line 237 of file ntrip_client.py.

◆ send_nmea()

def ntrip_client.ntrip_client.NTRIPClient.send_nmea (   self,
  sentence 
)

Definition at line 207 of file ntrip_client.py.

◆ shutdown()

def ntrip_client.ntrip_client.NTRIPClient.shutdown (   self)

Definition at line 289 of file ntrip_client.py.

Member Data Documentation

◆ _basic_credentials

ntrip_client.ntrip_client.NTRIPClient._basic_credentials
private

Definition at line 46 of file ntrip_client.py.

◆ _connected

ntrip_client.ntrip_client.NTRIPClient._connected
private

Definition at line 77 of file ntrip_client.py.

◆ _first_rtcm_received

ntrip_client.ntrip_client.NTRIPClient._first_rtcm_received
private

Definition at line 85 of file ntrip_client.py.

◆ _host

ntrip_client.ntrip_client.NTRIPClient._host
private

Definition at line 41 of file ntrip_client.py.

◆ _logdebug

ntrip_client.ntrip_client.NTRIPClient._logdebug
private

Definition at line 38 of file ntrip_client.py.

◆ _logerr

ntrip_client.ntrip_client.NTRIPClient._logerr
private

Definition at line 35 of file ntrip_client.py.

◆ _loginfo

ntrip_client.ntrip_client.NTRIPClient._loginfo
private

Definition at line 37 of file ntrip_client.py.

◆ _logwarn

ntrip_client.ntrip_client.NTRIPClient._logwarn
private

Definition at line 36 of file ntrip_client.py.

◆ _mountpoint

ntrip_client.ntrip_client.NTRIPClient._mountpoint
private

Definition at line 43 of file ntrip_client.py.

◆ _nmea_send_failed_count

ntrip_client.ntrip_client.NTRIPClient._nmea_send_failed_count
private

Definition at line 81 of file ntrip_client.py.

◆ _nmea_send_failed_max

ntrip_client.ntrip_client.NTRIPClient._nmea_send_failed_max
private

Definition at line 82 of file ntrip_client.py.

◆ _ntrip_version

ntrip_client.ntrip_client.NTRIPClient._ntrip_version
private

Definition at line 44 of file ntrip_client.py.

◆ _port

ntrip_client.ntrip_client.NTRIPClient._port
private

Definition at line 42 of file ntrip_client.py.

◆ _raw_socket

ntrip_client.ntrip_client.NTRIPClient._raw_socket
private

Definition at line 52 of file ntrip_client.py.

◆ _read_zero_bytes_count

ntrip_client.ntrip_client.NTRIPClient._read_zero_bytes_count
private

Definition at line 83 of file ntrip_client.py.

◆ _read_zero_bytes_max

ntrip_client.ntrip_client.NTRIPClient._read_zero_bytes_max
private

Definition at line 84 of file ntrip_client.py.

◆ _reconnect_attempt_count

ntrip_client.ntrip_client.NTRIPClient._reconnect_attempt_count
private

Definition at line 80 of file ntrip_client.py.

◆ _recv_rtcm_last_packet_timestamp

ntrip_client.ntrip_client.NTRIPClient._recv_rtcm_last_packet_timestamp
private

Definition at line 86 of file ntrip_client.py.

◆ _server_socket

ntrip_client.ntrip_client.NTRIPClient._server_socket
private

Definition at line 53 of file ntrip_client.py.

◆ _shutdown

ntrip_client.ntrip_client.NTRIPClient._shutdown
private

Definition at line 76 of file ntrip_client.py.

◆ _ssl_context

ntrip_client.ntrip_client.NTRIPClient._ssl_context
private

Definition at line 110 of file ntrip_client.py.

◆ ca_cert

ntrip_client.ntrip_client.NTRIPClient.ca_cert

Definition at line 73 of file ntrip_client.py.

◆ cert

ntrip_client.ntrip_client.NTRIPClient.cert

Definition at line 71 of file ntrip_client.py.

◆ DEFAULT_RECONNECT_ATEMPT_WAIT_SECONDS

int ntrip_client.ntrip_client.NTRIPClient.DEFAULT_RECONNECT_ATEMPT_WAIT_SECONDS = 5
static

Definition at line 30 of file ntrip_client.py.

◆ DEFAULT_RECONNECT_ATTEMPT_MAX

int ntrip_client.ntrip_client.NTRIPClient.DEFAULT_RECONNECT_ATTEMPT_MAX = 10
static

Definition at line 29 of file ntrip_client.py.

◆ DEFAULT_RTCM_TIMEOUT_SECONDS

int ntrip_client.ntrip_client.NTRIPClient.DEFAULT_RTCM_TIMEOUT_SECONDS = 4
static

Definition at line 31 of file ntrip_client.py.

◆ key

ntrip_client.ntrip_client.NTRIPClient.key

Definition at line 72 of file ntrip_client.py.

◆ nmea_parser

ntrip_client.ntrip_client.NTRIPClient.nmea_parser

Definition at line 62 of file ntrip_client.py.

◆ reconnect_attempt_max

ntrip_client.ntrip_client.NTRIPClient.reconnect_attempt_max

Definition at line 89 of file ntrip_client.py.

◆ reconnect_attempt_wait_seconds

ntrip_client.ntrip_client.NTRIPClient.reconnect_attempt_wait_seconds

Definition at line 90 of file ntrip_client.py.

◆ rtcm_parser

ntrip_client.ntrip_client.NTRIPClient.rtcm_parser

Definition at line 56 of file ntrip_client.py.

◆ rtcm_timeout_seconds

ntrip_client.ntrip_client.NTRIPClient.rtcm_timeout_seconds

Definition at line 91 of file ntrip_client.py.

◆ ssl

ntrip_client.ntrip_client.NTRIPClient.ssl

Definition at line 70 of file ntrip_client.py.


The documentation for this class was generated from the following file:


ntrip_client
Author(s): Parker Hannifin Corp
autogenerated on Thu Aug 18 2022 02:39:24