ESPHome  2022.12.8
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ble_client::BLEBinaryOutput Class Reference

#include <ble_binary_output.h>

Inheritance diagram for esphome::ble_client::BLEBinaryOutput:
esphome::output::BinaryOutput esphome::ble_client::BLEClientNode esphome::Component

Public Member Functions

void dump_config () override
void loop () override
float get_setup_priority () const override
void set_service_uuid16 (uint16_t uuid)
void set_service_uuid32 (uint32_t uuid)
void set_service_uuid128 (uint8_t *uuid)
void set_char_uuid16 (uint16_t uuid)
void set_char_uuid32 (uint32_t uuid)
void set_char_uuid128 (uint8_t *uuid)
void gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
void set_require_response (bool response)
- Public Member Functions inherited from esphome::output::BinaryOutput
void set_inverted (bool inverted)
 Set the inversion state of this binary output. More...
void set_power_supply (power_supply::PowerSupply *power_supply)
 Use this to connect up a power supply to this output. More...
virtual void set_state (bool state)
 Enable or disable this binary output. More...
virtual void turn_on ()
 Enable this binary output. More...
virtual void turn_off ()
 Disable this binary output. More...
bool is_inverted () const
 Return whether this binary output is inverted. More...
- Public Member Functions inherited from esphome::ble_client::BLEClientNode
virtual void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
void set_address (uint64_t address)
BLEClientparent ()
void set_ble_client_parent (BLEClient *parent)
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
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 ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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...

Protected Member Functions

void write_state (bool state) override
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_setup ()
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()> &&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()> &&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...

Protected Attributes

bool require_response_
espbt::ESPBTUUID service_uuid_
espbt::ESPBTUUID char_uuid_
espbt::ClientState client_state_
- Protected Attributes inherited from esphome::output::BinaryOutput
bool inverted_ {false}
power_supply::PowerSupplyRequester power_ {}
- Protected Attributes inherited from esphome::ble_client::BLEClientNode
uint64_t address_
- 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}

Additional Inherited Members

- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ClientState node_state

Detailed Description

Definition at line 15 of file ble_binary_output.h.

Member Function Documentation

◆ dump_config()

void esphome::ble_client::BLEBinaryOutput::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 11 of file ble_binary_output.cpp.

◆ gattc_event_handler()

void esphome::ble_client::BLEBinaryOutput::gattc_event_handler ( esp_gattc_cb_event_t  event,
esp_gatt_if_t  gattc_if,
esp_ble_gattc_cb_param_t *  param 

Implements esphome::ble_client::BLEClientNode.

Definition at line 19 of file ble_binary_output.cpp.

◆ get_setup_priority()

float esphome::ble_client::BLEBinaryOutput::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 19 of file ble_binary_output.h.

◆ loop()

void esphome::ble_client::BLEBinaryOutput::loop ( )

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 18 of file ble_binary_output.h.

◆ set_char_uuid128()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid128 ( uint8_t *  uuid)

Definition at line 25 of file ble_binary_output.h.

◆ set_char_uuid16()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid16 ( uint16_t  uuid)

Definition at line 23 of file ble_binary_output.h.

◆ set_char_uuid32()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid32 ( uint32_t  uuid)

Definition at line 24 of file ble_binary_output.h.

◆ set_require_response()

void esphome::ble_client::BLEBinaryOutput::set_require_response ( bool  response)

Definition at line 28 of file ble_binary_output.h.

◆ set_service_uuid128()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid128 ( uint8_t *  uuid)

Definition at line 22 of file ble_binary_output.h.

◆ set_service_uuid16()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid16 ( uint16_t  uuid)

Definition at line 20 of file ble_binary_output.h.

◆ set_service_uuid32()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid32 ( uint32_t  uuid)

Definition at line 21 of file ble_binary_output.h.

◆ write_state()

void esphome::ble_client::BLEBinaryOutput::write_state ( bool  state)

Implements esphome::output::BinaryOutput.

Definition at line 50 of file ble_binary_output.cpp.

Field Documentation

◆ char_uuid_

espbt::ESPBTUUID esphome::ble_client::BLEBinaryOutput::char_uuid_

Definition at line 34 of file ble_binary_output.h.

◆ client_state_

espbt::ClientState esphome::ble_client::BLEBinaryOutput::client_state_

Definition at line 35 of file ble_binary_output.h.

◆ require_response_

bool esphome::ble_client::BLEBinaryOutput::require_response_

Definition at line 32 of file ble_binary_output.h.

◆ service_uuid_

espbt::ESPBTUUID esphome::ble_client::BLEBinaryOutput::service_uuid_

Definition at line 33 of file ble_binary_output.h.

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