Files
MSE-SoftwEng/pico-sensor/McuLib/src/McuESP32.h
2025-05-06 13:07:01 +00:00

64 lines
1.4 KiB
C

/*
* Copyright (c) 2021, Erich Styger
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef McuESP32_H_
#define McuESP32_H_
#include <stdint.h>
#include "McuESP32config.h"
#ifdef __cplusplus
extern "C" {
#endif
/* used to deal with USB CDC flow control pins */
void McuESP32_UartState_Callback(uint8_t state);
#include "McuShell.h"
/*!
* \brief Shell parser routine.
* \param cmd Pointer to command line string.
* \param handled Pointer to status if command has been handled. Set to TRUE if command was understood.
* \param io Pointer to stdio handle
* \return Error code, ERR_OK if everything was ok.
*/
uint8_t McuESP32_ParseCommand(const unsigned char *cmd, bool *handled, const McuShell_StdIOType *io);
/*!
* \brief Set a standard I/O receiving from ESP
* \param stdio Standard I/O to be used
*/
void McuESP32_SetRxFromESPStdio(McuShell_ConstStdIOTypePtr stdio);
/*!
* \brief Return the current receiving from ESP standard I/O
* \return I/O handler
*/
McuShell_ConstStdIOTypePtr McuESP32_GetRxFromESPStdio(void);
/*!
* \brief Returns the standard I/O handler for sending data (only sending) to the ESP32
* \return standard I/O handler
*/
McuShell_ConstStdIOTypePtr McuESP32_GetTxToESPStdio(void);
/*!
* \brief Module de-initialization
*/
void McuESP32_Deinit(void);
/*!
* \brief Module initialization
*/
void McuESP32_Init(void);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* McuESP32_H_ */