uartat.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 "uartat_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _uartat_context {
        mraa_uart_context        uart;

        // wait time for reading results after sending a command.  The
        // default is 250ms.
        unsigned int cmd_resp_wait_ms;

        // filter carriage returns (CR) out of responses?
        bool filter_cr;
    } *uartat_context;

    uartat_context uartat_init(unsigned int uart, unsigned int baudrate);

    uartat_context uartat_init_tty(const char *uart_tty, unsigned int baudrate);

    void uartat_close(uartat_context dev);

    int uartat_read(const uartat_context dev, char *buffer, size_t len);

    int uartat_write(const uartat_context dev, const char *buffer, size_t len);

    upm_result_t uartat_set_baudrate(const uartat_context dev,
                                     unsigned int baudrate);

    void uartat_set_response_wait_time(const uartat_context dev,
                                       unsigned int wait_ms);

    bool uartat_data_available(const uartat_context dev,
                               unsigned int millis);

    bool uartat_command_mode(const uartat_context dev, const char *cmd_chars,
                             unsigned int guard_ms);

    bool uartat_in_command_mode(const uartat_context dev);

    void uartat_drain(const uartat_context dev);

    int uartat_command_with_response(const uartat_context dev,
                                     const char *cmd, char *resp,
                                     size_t resp_len);

    void uartat_command(const uartat_context dev, const char *cmd);

    bool uartat_command_waitfor(const uartat_context dev, const char *cmd,
                                char *resp, size_t resp_len,
                                const char *wait_string,
                                unsigned int millis);

    upm_result_t uartat_set_flow_control(const uartat_context dev,
                                         UARTAT_FLOW_CONTROL_T fc);

    bool uartat_find(const uartat_context dev, const char *buffer,
                     const char *str);

    void uartat_filter_cr(const uartat_context dev, bool enable);

#ifdef __cplusplus
}
#endif