mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-10-31 08:31:29 +01:00
Updating docs for the gps component. (#1094)
This commit is contained in:
parent
1b0e4fbdcf
commit
6103ef8bcf
@ -23,26 +23,69 @@ in your configuration - only the RX pin should be necessary.
|
||||
|
||||
# Example configuration entry
|
||||
uart:
|
||||
rx_pin: D0
|
||||
rx_pin: D7
|
||||
baud_rate: 9600
|
||||
|
||||
# Declare GPS module
|
||||
gps:
|
||||
latitude:
|
||||
name: "Latitude"
|
||||
longitude:
|
||||
name: "Longitude"
|
||||
altitude:
|
||||
name: "Altitude"
|
||||
|
||||
# GPS as time source
|
||||
time:
|
||||
- platform: gps
|
||||
|
||||
The component is split up in platforms. No configuration variables.
|
||||
The component is split up in platforms, by defining the GPS module
|
||||
(as seen above).
|
||||
|
||||
First you need to define a global GPS module hub (as seen above).
|
||||
|
||||
Currently, the only data that can be extracted from GPS is the current time.
|
||||
GPS can be used as a time platform to get the current date and time via the
|
||||
very accurate GPS clocks that are also independent of any network connection.
|
||||
In addition to retrieving GPS position data, the module can also be used as a
|
||||
time platform to get the current date and time via the very accurate GPS clocks
|
||||
without a network connection.
|
||||
|
||||
See :doc:`time` for config options for the GPS time source.
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
- **latitude** (*Optional*): Include the Latitude as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
- **longitude** (*Optional*): Include the Longitude as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
- **speed** (*Optional*): Include the measured speed as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
- **course** (*Optional*): Include the measured course as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
- **altitude** (*Optional*): Include the measured altitude as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
- **satellites** (*Optional*): Include the number of tracking satellites being used as a sensor
|
||||
|
||||
- **name** (**Required**, string): The name to give the latitude sensor
|
||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user