CC_DoorLock.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

 
#ifndef _CC_DOORLOCK_H_
#define _CC_DOORLOCK_H_
 
/****************************************************************************/
/*                              INCLUDE FILES                               */
/****************************************************************************/
#include <ZW_typedefs.h>
#include <ZW_classcmd.h>
#include <CC_Common.h>
#include <ZW_TransportEndpoint.h>
#include <ZAF_types.h>
#include "ZAF_CC_Invoker.h"

 
/****************************************************************************/
/*                     EXPORTED TYPES and DEFINITIONS                       */
/****************************************************************************/
typedef enum {
  DOOR_MODE_UNSECURE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_V2,                                                                                             
  DOOR_MODE_UNSECURE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_WITH_TIMEOUT_V2,                                                            
  DOOR_MODE_UNSECURE_INSIDE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_INSIDE_DOOR_HANDLES_V2,                                       
  DOOR_MODE_UNSECURE_INSIDE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_INSIDE_DOOR_HANDLES_WITH_TIMEOUT_V2,    
  DOOR_MODE_UNSECURE_OUTSIDE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_OUTSIDE_DOOR_HANDLES_V2,                                    
  DOOR_MODE_UNSECURE_OUTSIDE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_OUTSIDE_DOOR_HANDLES_WITH_TIMEOUT_V2, 
  DOOR_MODE_UNKNOWN = DOOR_LOCK_OPERATION_REPORT_DOOR_MODE_UNKNOWN_V4,  
  DOOR_MODE_SECURED = DOOR_LOCK_OPERATION_SET_DOOR_SECURED_V2                                                                                                   
} door_lock_mode_t;

typedef enum {
  DOOR_OPERATION_CONST = 0x01,   
  DOOR_OPERATION_TIMED = 0x02,   
  DOOR_OPERATION_RESERVED = 0x03 
}
cc_door_lock_operation_type_t;

typedef enum {
  DOOR_COMPONENT_DOOR = 0x01,
  DOOR_COMPONENT_BOLT = 0x02,
  DOOR_COMPONENT_LATCH = 0x04
} cc_door_lock_door_component_t;

typedef enum {
  DOOR_HANDLE_DISABLED = 0x00,
  DOOR_HANDLE_1 = 0x01,
  DOOR_HANDLE_2 = 0x02,
  DOOR_HANDLE_3 = 0x04,
  DOOR_HANDLE_4 = 0x08
} cc_door_lock_handle_t;

typedef struct {
  uint8_t reserved : 3; 
  uint8_t lengthSupportedOperationType : 5; 
  uint8_t supportedOperationTypeBitmask; 
  uint8_t lengthSupportedDoorLockModeList; 
  uint8_t supportedDoorLockModeList[8]; 
  uint8_t supportedOutsideHandleModes : 4; 
  uint8_t supportedInsideHandleModes : 4; 
  uint8_t supportedDoorComponents; 
  uint8_t autoRelockSupport : 1; 
  uint8_t holdAndReleaseSupport : 1; 
  uint8_t twistAssistSupport : 1; 
  uint8_t blockToBlockSupport : 1; 
} cc_door_lock_capabilities_report_t;

typedef struct {
  uint8_t type; 
  uint8_t insideDoorHandleMode : 4; 
  uint8_t outsideDoorHandleMode : 4; 
  uint8_t lockTimeoutMin; 
  uint8_t lockTimeoutSec; 
  uint8_t autoRelockTime1; 
  uint8_t autoRelockTime2; 
  uint8_t holdAndReleaseTime1; 
  uint8_t holdAndReleaseTime2; 
  uint8_t reservedOptionsFlags; 
} cc_door_lock_configuration_t;

typedef struct {
  door_lock_mode_t mode;
  cc_door_lock_operation_type_t type;
  uint8_t insideDoorHandleMode : 4; 
  uint8_t outsideDoorHandleMode : 4; 
  uint8_t insideDoorHandleState : 4; 
  uint8_t outsideDoorHandleState : 4; 
  uint8_t condition; 
  uint8_t lockTimeoutMin; 
  uint8_t lockTimeoutSec; 
} cc_door_lock_data_t;

typedef struct _door_lock_hw_data_t{
  // bool door_closed;   /// true for Closed, false for Open
  bool bolt_unlocked;  
  bool latch_closed;   
  bool handle_pressed; 
} door_lock_hw_data_t;

#define DOOR_LOCK_OPERATION_SET_TIMEOUT_NOT_SUPPORTED 0xFE

 
#define CC_DOOR_LOCK_CODE_EVENT_TOGGLE        1
#define CC_DOOR_LOCK_EVENT_OPERATION_SET_DONE 2 
#define CC_DOOR_LOCK_EVENT_HW_OPERATION_DONE  3 
 
/****************************************************************************/
/*                              EXPORTED DATA                               */
/****************************************************************************/
 
/****************************************************************************/
/*                           EXPORTED FUNCTIONS                             */
/****************************************************************************/

void cc_door_lock_latch_set(bool opened);

void cc_door_lock_handle_set(bool opened);

void cc_door_lock_bolt_set(bool locked);

void CC_DoorLock_SetOutsideDoorHandleState(cc_door_lock_handle_t handle);

void CC_DoorLock_ClearOutsideDoorHandleState(cc_door_lock_handle_t handle);

extern uint8_t cc_door_lock_mode_hw_change(door_lock_mode_t mode);

extern bool door_lock_hw_bolt_is_unlocked(void);

extern bool door_lock_hw_latch_is_closed(void);

extern bool door_lock_hw_handle_is_pressed(void);

 
#endif /* _CC_DOORLOCK_H_ */