Advanced Distributed Systems module at HSLU
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

39 lines
1.1 KiB

/**
* \file
* \brief This is the interface to Remote Controller Module
* \author Erich Styger, erich.styger@hslu.ch
* \license SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef __REMOTE_H_
#define __REMOTE_H_
#include "platform.h"
#if PL_CONFIG_USE_REMOTE
#include "McuShell.h"
/* called by the gateway task to put a char from the ESP into the queue for the remote */
void REMOTE_GatewayRxFromESP(unsigned char ch);
/* called by the gateway task to get chars from the remote task to be sent to the ESP32 */
bool REMOTE_GatewayTxToESP(unsigned char *pch);
/*!
* \brief Parses a command
* \param cmd Command string to be parsed
* \param handled Sets this variable to TRUE if command was handled
* \param io I/O stream to be used for input/output
* \return Error code, ERR_OK if everything was fine
*/
uint8_t REMOTE_ParseCommand(const unsigned char *cmd, bool *handled, const McuShell_StdIOType *io);
/*! \brief De-initialization of the module */
void REMOTE_Deinit(void);
/*! \brief Initialization of the module */
void REMOTE_Init(void);
#endif /* PL_CONFIG_USE_REMOTE */
#endif /* __REMOTE_H_ */