user_data.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_USER_DATA_H
#define XBEE_USER_DATA_H

#include "xbee/platform.h"
#include "xbee/device.h"

XBEE_BEGIN_DECLS

#define XBEE_FRAME_USER_DATA_TX         0x2D

#define XBEE_FRAME_USER_DATA_RX         0xAD

// Interface identifiers used with USER_DATA_TX and USER_DATA_RX frames.
#define XBEE_USER_DATA_IF_SERIAL        0x00    
#define XBEE_USER_DATA_IF_BLE           0x01    
#define XBEE_USER_DATA_IF_MICROPYTHON   0x02    

typedef XBEE_PACKED(xbee_header_user_data_tx_t, {
    uint8_t     frame_type;             
    uint8_t     frame_id;               
    uint8_t     destination;            
}) xbee_header_user_data_tx_t;

typedef XBEE_PACKED(xbee_frame_user_data_rx_t, {
    uint8_t     frame_type;             
    uint8_t     source;                 
    uint8_t     payload[1];             
}) xbee_frame_user_data_rx_t;

// See src/xbee/xbee_user_data.c for function documentation.

int xbee_user_data_relay_tx(xbee_dev_t *xbee, uint8_t dest,
                            const void *payload, uint16_t length);

const char *xbee_user_data_interface(uint8_t iface);

XBEE_END_DECLS

#endif // XBEE_USER_DATA_H