tr_door_lock_server.h

Go to the documentation of this file.

#ifndef TR_DOOR_LOCK_SERVER_H
#define TR_DOOR_LOCK_SERVER_H
 
#include "tr_af.h"
 
#ifndef TR_DOOR_LOCK_SERVER_MAX_PIN_LEN
#define TR_DOOR_LOCK_SERVER_MAX_PIN_LEN 4
#endif
 
#ifndef TR_DOOR_LOCK_SERVER_MAX_NUM_USERS
#define TR_DOOR_LOCK_SERVER_MAX_NUM_USERS 8
#endif
 
// Structures we use in this plugin in addition to common ZCL structures
typedef ZB_PACKED_PRE struct
{
    tr_door_lock_user_status_t status;
    tr_door_lock_user_type_t   type;
    zb_uint8_t                 pin[TR_DOOR_LOCK_SERVER_MAX_PIN_LEN + 1];
} ZB_PACKED_STRUCT tr_door_lock_server_user_t;
 
typedef ZB_PACKED_PRE struct
{
    zb_uint16_t                user_id;
    tr_door_lock_user_status_t user_status;
    tr_door_lock_user_type_t   user_type;
    zb_uint8_t                 pin[TR_DOOR_LOCK_SERVER_MAX_PIN_LEN + 1];
} ZB_PACKED_STRUCT tr_door_lock_get_pin_resp_t;
 
// typedef aliases for semantic clarity
typedef tr_door_lock_set_user_status_cmd_t tr_door_lock_get_user_status_resp_t;
typedef tr_door_lock_set_user_type_cmd_t   tr_door_lock_get_user_type_resp_t;

#if defined(TR_DOOR_LOCK_SERVER_PLUGIN_PRINT_ENABLE) && (TR_DOOR_LOCK_SERVER_PLUGIN_PRINT_ENABLE == 1)
#define tr_door_lock_server_printf(...)  tr_zcl_printf(__VA_ARGS__)
#define tr_door_lock_server_println(...) tr_zcl_println(__VA_ARGS__)
#else
#define tr_door_lock_server_printf(...)
#define tr_door_lock_server_println(...)
#endif


void tr_door_lock_server_init_cb(zb_uint8_t endpoint);

zb_bool_t tr_door_lock_server_command_received_cb(zb_zcl_parsed_hdr_t *cmd_info);

void tr_door_lock_server_write_attr_cb(zb_uint8_t  endpoint,
                                       zb_uint16_t attr_id,
                                       zb_uint8_t  *new_value,
                                       zb_uint16_t manuf_code);

zb_bool_t tr_door_lock_server_lock_door_cb(zb_zcl_parsed_hdr_t         *cmd_info,
                                           zb_uint8_t                  endpoint,
                                           tr_door_lock_event_source_t event_source,
                                           zb_uint8_t                  *pin);

zb_bool_t tr_door_lock_server_unlock_door_cb(zb_zcl_parsed_hdr_t         *cmd_info,
                                             zb_uint8_t                  endpoint,
                                             tr_door_lock_event_source_t event_source,
                                             zb_uint8_t                  *pin);

zb_bool_t tr_door_lock_server_set_pin_cb(zb_zcl_parsed_hdr_t        *cmd_info,
                                         zb_uint8_t                 endpoint,
                                         zb_uint16_t                user_id,
                                         tr_door_lock_user_status_t user_status,
                                         tr_door_lock_user_type_t   user_type,
                                         zb_uint8_t                 *pin);

zb_bool_t tr_door_lock_server_get_pin_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                         zb_uint8_t          endpoint,
                                         zb_uint16_t         user_id);

zb_bool_t tr_door_lock_server_clear_pin_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                           zb_uint8_t          endpoint,
                                           zb_uint16_t         user_id);

zb_bool_t tr_door_lock_server_clear_all_pins_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                zb_uint8_t          endpoint);

zb_bool_t tr_door_lock_server_set_user_status_cb(zb_zcl_parsed_hdr_t        *cmd_info,
                                                 zb_uint8_t                 endpoint,
                                                 zb_uint16_t                user_id,
                                                 tr_door_lock_user_status_t user_status);

zb_bool_t tr_door_lock_server_get_user_status_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                 zb_uint8_t          endpoint,
                                                 zb_uint16_t         user_id);

zb_bool_t tr_door_lock_server_set_user_type_cb(zb_zcl_parsed_hdr_t      *cmd_info,
                                               zb_uint8_t               endpoint,
                                               zb_uint16_t              user_id,
                                               tr_door_lock_user_type_t user_type);

zb_bool_t tr_door_lock_server_get_user_type_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                               zb_uint8_t          endpoint,
                                               zb_uint16_t         user_id);

void tr_door_lock_server_resp_sent_cb(zb_bufid_t param);



void tr_door_lock_server_lock(zb_uint8_t                  endpoint,
                              tr_door_lock_event_source_t event_source,
                              zb_uint8_t                  *pin);

void tr_door_lock_server_unlock(zb_uint8_t                  endpoint,
                                tr_door_lock_event_source_t event_source,
                                zb_uint8_t                  *pin);

void tr_door_lock_server_update_lock_state(zb_uint8_t  endpoint,
                                           zb_uint8_t  lock_state,
                                           zb_uint8_t  source,
                                           zb_uint16_t user,
                                           zb_uint8_t  *pin);

void tr_door_lock_server_send_op_event_notification(zb_uint8_t  endpoint,
                                                    zb_uint8_t  source,
                                                    zb_uint8_t  code,
                                                    zb_uint16_t user,
                                                    zb_uint8_t  *pin,
                                                    zb_uint8_t  mask_bit);

zb_uint32_t tr_get_auto_relock_time_seconds(zb_uint8_t endpoint);

zb_bool_t tr_door_lock_server_verify_user(zb_uint8_t  endpoint,
                                          zb_bool_t   rf_operation,
                                          zb_uint8_t  *pin,
                                          zb_uint16_t *user);

tr_door_lock_set_pin_or_id_status_t tr_door_lock_server_add_user(zb_uint16_t                user,
                                                                 tr_door_lock_user_status_t status,
                                                                 tr_door_lock_user_type_t   type,
                                                                 zb_uint8_t                 *pin);

zb_bool_t tr_door_lock_server_get_user(zb_uint16_t                 user,
                                       tr_door_lock_get_pin_resp_t *user_info);

zb_bool_t tr_door_lock_server_delete_user(zb_uint16_t user);

void tr_door_lock_server_delete_all_pin_users(void);

zb_bool_t tr_door_lock_server_set_user_status(zb_uint16_t                user,
                                              tr_door_lock_user_status_t user_status);

zb_bool_t tr_door_lock_server_get_user_status(zb_uint16_t                         user,
                                              tr_door_lock_get_user_status_resp_t *user_info);

zb_bool_t tr_door_lock_server_set_user_type(zb_uint16_t              user,
                                            tr_door_lock_user_type_t user_type);

zb_bool_t tr_door_lock_server_get_user_type(zb_uint16_t                       user,
                                            tr_door_lock_get_user_type_resp_t *user_info);

void tr_door_lock_server_print_users(void);


void tr_door_lock_server_init(void);
 
// user management functions
void tr_door_lock_server_users_init(void);
void tr_door_lock_server_register_nv(void);
 
#endif // TR_DOOR_LOCK_SERVER_H