user_credential_user_capabilities.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2024 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef USER_CREDENTIAL_USER_CAPABILITIES_H
#define USER_CREDENTIAL_USER_CAPABILITIES_H
 
// Attribute store
#include "attribute.hpp"
// User credential types
#include "zwave_command_class_user_credential_types.h"
 
 
namespace user_credential
{
 
class user_capabilities
{
  public:
  explicit user_capabilities(attribute_store::attribute endpoint_node);
  ~user_capabilities() = default;
 
  bool is_user_valid(user_credential_user_unique_id_t user_id,
                     user_credential_type_t user_type,
                     user_credential_rule_t credential_rule,
                     const char *user_name) const;
 
  bool is_user_name_valid(const char *user_name) const;
 
  bool is_user_id_valid(user_credential_user_unique_id_t user_id) const;
  bool is_user_type_supported(user_credential_type_t user_type) const;
 
  bool
    is_credential_rule_supported(user_credential_rule_t credential_rule) const;
 
  bool is_all_users_checksum_supported() const;
 
  bool is_user_checksum_supported() const;
  bool is_user_schedule_supported() const;
 
  private:
  // Maximum number of users that can be stored in the device
  uint16_t max_user_count = 0;
  // Credential rules supported
  uint8_t supported_credential_rules_bitmask = 0;
  // User types supported
  uint32_t supported_user_types_bitmask = 0;
  // Max length for the user names
  uint8_t max_user_name_length = 0;
  // Device support for scheduling users
  uint8_t support_user_schedule = 0;
  // Device support for getting the checksum of all users
  uint8_t support_all_users_checksum = 0;
  // Device support for getting the checksum of a specific user
  uint8_t support_by_user_checksum = 0;
 
  // True if the data is valid inside this struct
  bool is_data_valid = false;
};
 
}  // namespace user_credential
 
#endif  // USER_CREDENTIAL_USER_CAPABILITIES_H