lock.hpp

Go to the documentation of this file.

#pragma once
 
 
#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>
 
namespace esphome::api {
 
namespace proto {
class ListEntitiesLockResponse;
class LockStateResponse;
class LockCommandRequest;
}  // namespace proto
 
enum class LockCommand : std::int32_t {
    Unlock = 0,  // LOCK_UNLOCK
    Lock = 1,    // LOCK_LOCK
    Open = 2,    // LOCK_OPEN
};
 
struct LockInfo : EntityInfo {
    bool assumed_state = false;
    bool supports_open = false;
    bool requires_code = false;
    std::string code_format;
};
 
struct LockEntityState {
    std::uint32_t key = 0;
    LockState state = LockState::None;
};
 
struct LockCommandData {
    std::uint32_t key = 0;
    LockCommand command = LockCommand::Unlock;
    std::optional<std::string> code;
};
 
LockInfo parse_lock_info(const proto::ListEntitiesLockResponse& msg);
LockEntityState parse_lock_state(const proto::LockStateResponse& msg);
std::unique_ptr<ProtoMessage> to_message(const LockCommandData& cmd);
 
}  // namespace esphome::api