register_device.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef XBEE_REGISTER_DEVICE_H
#define XBEE_REGISTER_DEVICE_H

#include "xbee/device.h"
#include "wpan/types.h"

XBEE_BEGIN_DECLS

#define XBEE_ZIGBEE_INSTALL_KEY_LEN     18      
#define XBEE_ZIGBEE_LINK_KEY_MAXLEN     16      

#define XBEE_FRAME_REGISTER_DEVICE              0x24
typedef XBEE_PACKED(xbee_header_register_device_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    addr64      device_addr_be; 
    uint16_t    reserved_be;    
    uint8_t     options;        
#define XBEE_REG_DEV_OPT_LINK_KEY       0x00
#define XBEE_REG_DEV_OPT_INSTALL_CODE   0x01
    // header followed by optional key (1-16 bytes for link key, 18 bytes for
    // install code, 0 bytes to deregister a device)
}) xbee_header_register_device_t;

#define XBEE_FRAME_REGISTER_DEVICE_STATUS       0xA4
typedef XBEE_PACKED(xbee_frame_register_device_status_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     status;         
#define XBEE_REG_DEV_STATUS_SUCCESS             0x00
#define XBEE_REG_DEV_STATUS_KEY_TOO_LONG        0x01
#define XBEE_REG_DEV_STATUS_ADDR_NOT_FOUND      0xB1
#define XBEE_REG_DEV_STATUS_KEY_INVALID         0xB2
#define XBEE_REG_DEV_STATUS_ADDR_INVALID        0xB3
#define XBEE_REG_DEV_STATUS_KEY_TABLE_FULL      0xB4
#define XBEE_REG_DEV_STATUS_BAD_INSTALL_CRC     0xBD
#define XBEE_REG_DEV_STATUS_KEY_NOT_FOUND       0xFF
}) xbee_frame_register_device_status_t;

int xbee_register_device(xbee_dev_t *xbee, addr64 device_addr_be,
                         const void *key, unsigned key_len);

#define XBEE_REGISTER_DEVICE_STR_BUF_SIZE       40

const char *xbee_register_device_status_str(
    uint8_t status, char buffer[XBEE_REGISTER_DEVICE_STR_BUF_SIZE]);

int xbee_dump_register_device_status(xbee_dev_t *xbee, const void FAR *rawframe,
                                     uint16_t length, void FAR *context);

XBEE_END_DECLS

#endif // XBEE_REGISTER_DEVICE_H