esphome-api-client 0.5.0
Modern C++17 client for the ESPHome native API (plaintext + Noise)
Loading...
Searching...
No Matches
Classes | Namespaces | Enumerations | Functions
lock.hpp File Reference

Typed Lock entity (info + state + command). More...

#include <esphome/api/model/entity.hpp>
#include <esphome/api/model/enums.hpp>
#include <esphome/api/proto/proto_message.hpp>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
Include dependency graph for lock.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  esphome::api::LockInfo
 Static description of a lock entity. More...
 
struct  esphome::api::LockEntityState
 A lock's reported state. More...
 
struct  esphome::api::LockCommandData
 A command targeting a lock entity. More...
 

Namespaces

namespace  esphome
 
namespace  esphome::api
 
namespace  esphome::api::proto
 

Enumerations

enum class  esphome::api::LockCommand : std::int32_t { esphome::api::Unlock = 0 , esphome::api::Lock = 1 , esphome::api::Open = 2 }
 Mirror of proto enum LockCommand (not present in the generated enums mirror). More...
 

Functions

LockInfo esphome::api::parse_lock_info (const proto::ListEntitiesLockResponse &msg)
 
LockEntityState esphome::api::parse_lock_state (const proto::LockStateResponse &msg)
 
std::unique_ptr< ProtoMessageesphome::api::to_message (const LockCommandData &cmd)
 

Detailed Description

Typed Lock entity (info + state + command).