#include <gps.h>

Inheritance diagram for esphome::gps::GPS:

Public Member Functions
void	set_latitude_sensor (sensor::Sensor *latitude_sensor)

void	set_longitude_sensor (sensor::Sensor *longitude_sensor)

void	set_speed_sensor (sensor::Sensor *speed_sensor)

void	set_course_sensor (sensor::Sensor *course_sensor)

void	set_altitude_sensor (sensor::Sensor *altitude_sensor)

void	set_satellites_sensor (sensor::Sensor *satellites_sensor)

void	register_listener (GPSListener *listener)

float	get_setup_priority () const override

void	loop () override

void	update () override

TinyGPSPlus &	get_tiny_gps ()

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen. More...

virtual void	dump_config ()

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Public Member Functions inherited from esphome::uart::UARTDevice
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	write_array (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

int	available ()

void	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

void	check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...

Protected Attributes
float	latitude_ = -1

float	longitude_ = -1

float	speed_ = -1

float	course_ = -1

float	altitude_ = -1

int	satellites_ = -1

sensor::Sensor *	latitude_sensor_ {nullptr}

sensor::Sensor *	longitude_sensor_ {nullptr}

sensor::Sensor *	speed_sensor_ {nullptr}

sensor::Sensor *	course_sensor_ {nullptr}

sensor::Sensor *	altitude_sensor_ {nullptr}

sensor::Sensor *	satellites_sensor_ {nullptr}

bool	has_time_ {false}

TinyGPSPlus	tiny_gps_

std::vector< GPSListener * >	listeners_ {}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Detailed Description

Definition at line 28 of file gps.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::gps::GPS::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file gps.h.

◆ get_tiny_gps()

TinyGPSPlus& esphome::gps::GPS::get_tiny_gps ( )

inline

Definition at line 46 of file gps.h.

◆ loop()

void esphome::gps::GPS::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file gps.cpp.

◆ register_listener()

void esphome::gps::GPS::register_listener ( GPSListener * listener )

inline

Definition at line 37 of file gps.h.

◆ set_altitude_sensor()

void esphome::gps::GPS::set_altitude_sensor ( sensor::Sensor * altitude_sensor )

inline

Definition at line 34 of file gps.h.

◆ set_course_sensor()

void esphome::gps::GPS::set_course_sensor ( sensor::Sensor * course_sensor )

inline

Definition at line 33 of file gps.h.

◆ set_latitude_sensor()

void esphome::gps::GPS::set_latitude_sensor ( sensor::Sensor * latitude_sensor )

inline

Definition at line 30 of file gps.h.

◆ set_longitude_sensor()

void esphome::gps::GPS::set_longitude_sensor ( sensor::Sensor * longitude_sensor )

inline

Definition at line 31 of file gps.h.

◆ set_satellites_sensor()

void esphome::gps::GPS::set_satellites_sensor ( sensor::Sensor * satellites_sensor )

inline

Definition at line 35 of file gps.h.

◆ set_speed_sensor()

void esphome::gps::GPS::set_speed_sensor ( sensor::Sensor * speed_sensor )

inline

Definition at line 32 of file gps.h.

◆ update()

void esphome::gps::GPS::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 13 of file gps.cpp.

Field Documentation

◆ altitude_

float esphome::gps::GPS::altitude_ = -1

protected

Definition at line 53 of file gps.h.

◆ altitude_sensor_

sensor::Sensor* esphome::gps::GPS::altitude_sensor_ {nullptr}

protected

Definition at line 60 of file gps.h.

◆ course_

float esphome::gps::GPS::course_ = -1

protected

Definition at line 52 of file gps.h.

◆ course_sensor_

sensor::Sensor* esphome::gps::GPS::course_sensor_ {nullptr}

protected

Definition at line 59 of file gps.h.

◆ has_time_

bool esphome::gps::GPS::has_time_ {false}

protected

Definition at line 63 of file gps.h.

◆ latitude_

float esphome::gps::GPS::latitude_ = -1

protected

Definition at line 49 of file gps.h.

◆ latitude_sensor_

sensor::Sensor* esphome::gps::GPS::latitude_sensor_ {nullptr}

protected

Definition at line 56 of file gps.h.

◆ listeners_

std::vector<GPSListener *> esphome::gps::GPS::listeners_ {}

protected

Definition at line 65 of file gps.h.

◆ longitude_

float esphome::gps::GPS::longitude_ = -1

protected

Definition at line 50 of file gps.h.

◆ longitude_sensor_

sensor::Sensor* esphome::gps::GPS::longitude_sensor_ {nullptr}

protected

Definition at line 57 of file gps.h.

◆ satellites_

int esphome::gps::GPS::satellites_ = -1

protected

Definition at line 54 of file gps.h.

◆ satellites_sensor_

sensor::Sensor* esphome::gps::GPS::satellites_sensor_ {nullptr}

protected

Definition at line 61 of file gps.h.

◆ speed_

float esphome::gps::GPS::speed_ = -1

protected

Definition at line 51 of file gps.h.

◆ speed_sensor_

sensor::Sensor* esphome::gps::GPS::speed_sensor_ {nullptr}

protected

Definition at line 58 of file gps.h.

◆ tiny_gps_

TinyGPSPlus esphome::gps::GPS::tiny_gps_

protected

Definition at line 64 of file gps.h.

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

/opt/build/esphome/esphome/components/gps/gps.h
/opt/build/esphome/esphome/components/gps/gps.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_setup_priority()

◆ get_tiny_gps()

◆ loop()

◆ register_listener()

◆ set_altitude_sensor()

◆ set_course_sensor()

◆ set_latitude_sensor()

◆ set_longitude_sensor()

◆ set_satellites_sensor()

◆ set_speed_sensor()

◆ update()

Field Documentation

◆ altitude_

◆ altitude_sensor_

◆ course_

◆ course_sensor_

◆ has_time_

◆ latitude_

◆ latitude_sensor_

◆ listeners_

◆ longitude_

◆ longitude_sensor_

◆ satellites_

◆ satellites_sensor_

◆ speed_

◆ speed_sensor_

◆ tiny_gps_