Bridges raw Z-Wave frames between a client and the device's Z-Wave radio. More...
#include <zwave_proxy.hpp>
Inheritance diagram for esphome::api::ZWaveProxy:
Collaboration diagram for esphome::api::ZWaveProxy:
Public Types | |
| using | FrameHandler = std::function< void(const ZWaveProxyFrame &)> |
Public Member Functions | |
| ZWaveProxy (Client &client) | |
| void | on_frame (FrameHandler handler) |
| Register a callback fired for each incoming ZWaveProxyFrame. | |
| void | send_frame (const std::string &data) const |
| Send a raw Z-Wave frame to the device. | |
| void | request (ZWaveProxyRequestType type, const std::string &data={}) const |
| Issue a proxy control request (subscribe, unsubscribe, home id change). | |
 Public Member Functions inherited from esphome::api::Subsystem | |
| Subsystem (Client &client) | |
Additional Inherited Members | |
| Protected Attributes inherited from esphome::api::Subsystem | |
| Client & | client_ |
Detailed Description
Bridges raw Z-Wave frames between a client and the device's Z-Wave radio.
Member Typedef Documentation
◆ FrameHandler
| using esphome::api::ZWaveProxy::FrameHandler = std::function<void(const ZWaveProxyFrame&)> |
Constructor & Destructor Documentation
◆ ZWaveProxy()
|
inlineexplicit |
Member Function Documentation
◆ on_frame()
| void esphome::api::ZWaveProxy::on_frame | ( | FrameHandler | handler | ) |
Register a callback fired for each incoming ZWaveProxyFrame.
◆ request()
| void esphome::api::ZWaveProxy::request | ( | ZWaveProxyRequestType | type, |
| const std::string & | data = {} |
||
| ) | const |
Issue a proxy control request (subscribe, unsubscribe, home id change).
data carries the optional request payload.
◆ send_frame()
| void esphome::api::ZWaveProxy::send_frame | ( | const std::string & | data | ) | const |
Send a raw Z-Wave frame to the device.
The documentation for this class was generated from the following file:
- include/esphome/api/subsystems/zwave_proxy.hpp
