cli_uart_interface.h File Reference

Z-Wave radio test CLI tool uart interface. More...

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <zpal_uart.h>
#include "embedded_cli.h"
#include "radio_cli_commands.h"

Include dependency graph for cli_uart_interface.h:

Go to the source code of this file.

Macros
#define	RECEIVE_BUFFER_SIZE   32
	Receive buffer size.
#define	TRANSMIT_BUFFER_SIZE   100
	Transmit buffer size.

Typedefs
typedef void(*	receiveCharHook_t) (char value)

Functions
void	cli_uart_receive_hook_set (receiveCharHook_t receiveCharFunc)
void	cli_uart_init (zpal_uart_id_t uart, void(*callback)())
	Initializes the given UART and the CLI.
void	cli_uart_process (void)
void	cli_uart_print (const char *message)
void	cli_uart_printf (const char *pFormat,...)
void	cli_uart_receive_handler (void)

Detailed Description

Z-Wave radio test CLI tool uart interface.

---

SPDX-License-Identifier: LicenseRef-TridentMSLA SPDX-FileCopyrightText: 2024 Trident IoT, LLC https://www.tridentiot.com

---

Macro Definition Documentation

RECEIVE_BUFFER_SIZE

#define RECEIVE_BUFFER_SIZE   32

Receive buffer size.

TRANSMIT_BUFFER_SIZE

#define TRANSMIT_BUFFER_SIZE   100

Transmit buffer size.

Typedef Documentation

receiveCharHook_t

typedef void(* receiveCharHook_t) (char value)

function callback definition for use when redirecting uart received data

Parameters

[out]

value

Function Documentation

cli_uart_init()

void cli_uart_init	(	zpal_uart_id_t	uart,
		void(*)()	callback )

Initializes the given UART and the CLI.

Parameters

[in]	uart	UART ID
[in]	callback	Callback function invoked on UART reception.

cli_uart_print()

void cli_uart_print

(

const char *

message

)

Blocking function for printing a string to UART

Parameters

[in]

message

Message to print on the UART.

cli_uart_printf()

void cli_uart_printf	(	const char *	pFormat,
			... )

Blocking printf for output on the CLI

Parameters

[in]

pFormat

Format to use for printing.

cli_uart_process()

void cli_uart_process

(

void

)

Process incomming data in the CLI

cli_uart_receive_handler()

void cli_uart_receive_handler

(

void

)

CLI UART Receive Handler

cli_uart_receive_hook_set()

void cli_uart_receive_hook_set

(

receiveCharHook_t

receiveCharFunc

)

Function for redirecting received uart data from embeddedCLI

Parameters

[in]

receiveCharFunc