rn2903.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2017 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include <stdint.h>
#include <stdlib.h>
#include <unistd.h>

#include <upm.h>
#include <mraa/uart.h>

#include "rn2903_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _rn2903_context {
        mraa_uart_context        uart;
        // store the baudrate
        int                      baudrate;

        // response data buffer, stripped of CR/LF
        char                     resp_data[RN2903_MAX_BUFFER];
        // length of response data
        size_t                   resp_len;

        // these are allocated buffers we use manage and reuse
        // internally to store conversions from/to hex and back
        char                     *to_hex_buf;
        char                     *from_hex_buf;

        // maximum time to wait for a response after a command is
        // submitted
        int                      cmd_resp_wait_ms;

        // maximum time to wait for a second response after a command is
        // submitted
        int                      cmd_resp2_wait_ms;

        // debugging output
        bool                     debug;

        // our hardware hex encoded EUI + terminating NULL
        char                     hardware_eui[RN2903_MAX_HEX_EUI64 + 1];

        // 16b mac status word
        uint16_t                 mac_status_word;
        // this is the mac_status bitfield of the mac status word
        RN2903_MAC_STATUS_T      mac_mac_status;
    } *rn2903_context;

    rn2903_context rn2903_init(unsigned int uart, unsigned int baudrate);

    rn2903_context rn2903_init_tty(const char *uart_tty, unsigned int baudrate);

    void rn2903_close(rn2903_context dev);

    void rn2903_set_response_wait_time(const rn2903_context dev,
                                       unsigned int wait_ms);

    void rn2903_set_response2_wait_time(const rn2903_context dev,
                                        unsigned int wait_ms);

    bool rn2903_data_available(const rn2903_context dev,
                               unsigned int millis);

    void rn2903_drain(const rn2903_context dev);

    RN2903_RESPONSE_T rn2903_command(const rn2903_context dev,
                                     const char *cmd);

    RN2903_RESPONSE_T rn2903_command_with_arg(const rn2903_context dev,
                                              const char *cmd,
                                              const char *arg);

    RN2903_RESPONSE_T rn2903_waitfor_response(const rn2903_context dev,
                                              int wait_ms);

    const char *rn2903_get_response(const rn2903_context dev);

    size_t rn2903_get_response_len(const rn2903_context dev);

    upm_result_t rn2903_set_device_eui(const rn2903_context dev,
                                       const char *str);

    upm_result_t rn2903_get_device_eui(const rn2903_context dev);

    upm_result_t rn2903_set_application_eui(const rn2903_context dev,
                                            const char *str);

    upm_result_t rn2903_get_application_eui(const rn2903_context dev);

    upm_result_t rn2903_set_application_key(const rn2903_context dev,
                                            const char *str);

    upm_result_t rn2903_get_application_key(const rn2903_context dev);

    upm_result_t rn2903_set_device_addr(const rn2903_context dev,
                                        const char *str);

    upm_result_t rn2903_get_device_addr(const rn2903_context dev);

    upm_result_t rn2903_set_network_session_key(const rn2903_context dev,
                                                const char *str);

    upm_result_t rn2903_set_application_session_key(const rn2903_context dev,
                                                    const char *str);

    const char *rn2903_to_hex(const rn2903_context dev,
                              const char *src, int len);

    const char *rn2903_from_hex(const rn2903_context dev,
                                const char *src);

    RN2903_JOIN_STATUS_T rn2903_join(const rn2903_context dev,
                                     RN2903_JOIN_TYPE_T type);

    RN2903_MAC_TX_STATUS_T rn2903_mac_tx(const rn2903_context dev,
                                         RN2903_MAC_MSG_TYPE_T type,
                                         int port, const char *payload);

    RN2903_RESPONSE_T rn2903_radio_tx(const rn2903_context dev,
                                      const char *payload);

    RN2903_RESPONSE_T rn2903_radio_rx(const rn2903_context dev,
                                      int window_size);

    const char *rn2903_get_hardware_eui(const rn2903_context dev);

    upm_result_t rn2903_update_mac_status(const rn2903_context dev);

    uint16_t rn2903_get_mac_status_word(const rn2903_context dev);

    RN2903_MAC_STATUS_T rn2903_get_mac_status(const rn2903_context dev);

    upm_result_t rn2903_mac_save(const rn2903_context dev);

    upm_result_t rn2903_mac_pause(const rn2903_context dev);

    upm_result_t rn2903_mac_resume(const rn2903_context dev);

    upm_result_t rn2903_reset(const rn2903_context dev);

    upm_result_t rn2903_mac_set_battery(const rn2903_context dev, int level);

    void rn2903_set_debug(const rn2903_context dev, bool enable);

    int rn2903_read(const rn2903_context dev, char *buffer, size_t len);

    int rn2903_write(const rn2903_context dev, const char *buffer, size_t len);

    upm_result_t rn2903_set_baudrate(const rn2903_context dev,
                                     unsigned int baudrate);

    upm_result_t rn2903_set_flow_control(const rn2903_context dev,
                                         RN2903_FLOW_CONTROL_T fc);

    bool rn2903_find(const rn2903_context dev, const char *str);

    const char *rn2903_get_radio_rx_payload(const rn2903_context dev);

    bool rn2903_autobaud(const rn2903_context dev, int retries);

#ifdef __cplusplus
}
#endif