.. |br| raw:: html
.. _ntrip: NTRIP ===== The NTRIP class implements NTRIP client and NTRIP server and will make your integration easy. .. note:: This is an asynchronous class, we advise the reader to check the example to understand better how it works. |br| Asynchronous tasks permit multiple tasks to be executed in *parallel*, without blocking each other, even if the processor has only one core. |br| When you run a set of synchronous tasks, you wait for each task to finish before moving on to the next one. When run tasks asynchronously, you can move on to another task before the current one is finished. |br| If the reader is not familiar with asynchronous tasks, we suggest to read more about them. Methods ------- .. class:: ntr.Ntr_Cli(user, host, port, mp, periodGGA_s=-1) The ``ntr.Ntr_Cli`` class is used to create an object that will provide NTRIP corrections to the SBC. The class needs to be initialized with the following parameters: .. csv-table:: :header: Parameter name, Value, Description :widths: 10, 10, 10 ``user``, "'username:password'", NTRIP caster credentials. |br| Leave blank if not needed. ``host``, "e.g: '192.168.1.1' or 'rtk2go.com'", "NTRIP caster hostname. |br| Can be an IP address or hostname" ``port``, "e.g: '2101'", "NTRIP caster port." ``mp``, "e.g: 'ARDU1'", "NTRIP caster mountpoint." ``periodGGA_s``, "e.g.: 10", "Period in seconds at which |br| the application will send GGA |br| sentences to the NTRIP caster. |br| If no GGA reporting is needed, |br| set this parameter to 0." .. method:: enable(): Enables NTRIP client Example to enable NTRIP client: >>> ntr_cli = sbc.ntr.Ntr_Cli(user = 'ardusimple:1234', host = 'rtk2go.com', port = '2101', mp = 'ARDU1', periodGGA_s = 10) >>> ntr_cli.enable() .. method:: disable(): Disabled NTRIP client Example to disable NTRIP client: >>> ntr_cli = sbc.ntr.Ntr_Cli(user = 'ardusimple:1234', host = 'rtk2go.com', port = '2101', mp = 'ARDU1', periodGGA_s = 10) >>> ntr_cli.disable()