gps
---

.. osdx:cfgcmd:: service gps <id>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg id:
        GPS Service


    :instances: Multiple

    :ref Required: controllers gps *


.. osdx:cfgcmd:: service gps <id> geofence

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    GPS advisor for geofence feature






.. osdx:cfgcmd:: service gps <id> geofence zone <u32>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg u32:
        Create zone


    :instances: Multiple

    :ref Required: 
    :ref Required: 
    :ref Required: system alarm *


.. osdx:cfgcmd:: service gps <id> geofence zone <u32> alarm <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    Configure GPS advisor



    :ref Reference: system alarm *



.. osdx:cfgcmd:: service gps <id> geofence zone <u32> coverage-fail-state <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    State on coverage failure

    :arg true:
        Coverage failure state is IN of zone
    :arg false:
        Coverage failure state is OUT of zone
    :arg true-time-false:
        After a time, state change from IN to OUT
    :arg false-time-true:
        After a time, state change from OUT to IN
    :arg last-state:
        Coverage fail state is the last state
    :arg last-time-false:
        After a time, state change from last-state to OUT
    :arg last-time-true:
        After a time, state change from last-state to IN





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> coverage-fail-state-time <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Timeout for a change of coverage fail state (HH:MM:SS)

        <00:01:00..01:00:00>





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> initial-state <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    Initial state at power ON

    :arg true:
        Initial state is IN of zone
    :arg false:
        Initial state is OUT of zone
    :arg true-time-false:
        After a time, state change from IN to OUT
    :arg false-time-true:
        After a time, state change from OUT to IN





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> initial-state-time <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Timeout for a change of state (HH:MM:SS)

        <00:01:00..01:00:00>





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> latitude <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Latitude range of the zone, for example 45°30.5N. Use º or ° as degrees symbol.


    :instances: Multiple

    :ref Required: 


.. osdx:cfgcmd:: service gps <id> geofence zone <u32> latitude <txt> to <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Latitude range of the zone, for example 45°30.5N. Use º or ° as degrees symbol.





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> longitude <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Longitude range of the zone, for example 123°45.67E. Use º or ° as degrees symbol.


    :instances: Multiple

    :ref Required: 


.. osdx:cfgcmd:: service gps <id> geofence zone <u32> longitude <txt> to <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Longitude range of the zone, for example 123°45.67E. Use º or ° as degrees symbol.





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> time-to-false <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Time to validate IN of zone (HH:MM:SS)

        <00:01:00..01:00:00>





.. osdx:cfgcmd:: service gps <id> geofence zone <u32> time-to-true <txt>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>


    :arg txt:
        Time to validate OUT of zone (HH:MM:SS)

        <00:01:00..01:00:00>





.. osdx:cfgcmd:: service gps <id> log-level <id>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    Specific log-level to use

    :arg emerg:
        Emergency messages
    :arg alert:
        Alert messages
    :arg crit:
        Critical messages
    :arg err:
        Error messages
    :arg warning:
        Warning messages
    :arg notice:
        Notice messages
    :arg info:
        Informational messages (log all GPS sentences)
    :arg debug:
        Debug messages (log all GPS sentences)





.. osdx:cfgcmd:: service gps <id> source <id>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    GPS (GNSS) controller

    :arg id:
        GPS controller name


    :ref Reference: controllers gps *
    :instances: Multiple



.. osdx:cfgcmd:: service gps <id> tcp-enable

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    Enable tcp remote connection






.. osdx:cfgcmd:: service gps <id> tcp-port <u32>

    .. raw:: html

        <span class="badge" style="background-color: darkviolet">H5-Rail</span>

    Configure listen tcp port

    :arg u32:
        Integer value from 1024 to 49151 (1024-49151)