1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/sys/stdio_udp/doc.txt
2023-01-13 11:08:22 +01:00

30 lines
901 B
Plaintext

/*
* Copyright (C) 2023 ML!PA Consulting GmbH
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup sys_stdio_udp STDIO over UDP
* @ingroup sys_stdio
* @brief STDIO over UDP implementation
*
* This file implements STDIO via a UDP that can be used with e.g. netcat:
*
* nc -u fe80::7837:fcff:fe7d:1aaf%tapbr0 2323
*
* It can be enabled with
*
* USEMODULE += stdio_udp
*
* and will listen on `CONFIG_STDIO_UDP_PORT` for incoming connections.
*
* You will also have to set `I_UNDERSTAND_THAT_STDIO_UDP_IS_INSECURE = 1` to
* acknowledge that you will only use this for debugging in an isolated network.
*
* @warning This is entirely unsecured, only use this for debugging in
* an isolated network!
*/