Skip to content

docs: implement TODO to describe CLI arguments in help output #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hackpaul wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: implement TODO to describe CLI arguments in help output #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6df8c1d
docs: implement TODO to describe CLI arguments in help output
Hackpaul Feb 14, 2026
6754c4f
Update run.sh with CoAP command usage details
Hackpaul Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,40 @@ allArgsAreNumbers() {
done
}

# TODO: Describe args
function showHelp() {
echo "Usage:"
echo " $0 start <protocol> [args...]"
echo " $0 stop <protocol>"
echo " $0 status"
echo
echo "Servers and required arguments:"
echo " "
echo " telnet <port> <delay> <max-clients>"
echo " - port: "
echo " - delay: "
echo " - max-no-clients: "
echo
echo " upnp <http-port> <ssdp-port> <delay> <max-clients>"
echo " - http-port: "
echo " - ssdp-port: "
echo " - delay: "
echo " - max-clients: "
echo
echo " - port: The local port to listen for incoming Telnet connections."
echo " - delay: Time in ms to wait before sending data to trap the client."
echo " - max-clients: Maximum number of concurrent connections allowed."
echo " "
echo " upnp <http-port> <ssdp-port> <delay> <max-clients>"
echo " - http-port: Port for HTTP-based UPnP emulation."
echo " - ssdp-port: Port for SSDP discovery traffic (UDP 1900)."
echo " - delay: Response delay in ms to slow down automated scanners."
echo " - max-clients: Limit for simultaneous UPnP connection states."
echo " "
echo " mqtt <port> <max-events> <epoll-interval> <pubrel-interval> <max-packets> <max-clients>"
echo " - port: "
echo " - max-events: "
echo " - epoll-interval: "
echo " - pubrel-interval: "
echo " - max_packets: "
echo " - max-clients: "
echo " - port: The local port for the MQTT broker emulator."
echo " - max-events: Max events to process in a single epoll_wait cycle."
echo " - epoll-interval: Time in ms to wait between I/O polling cycles."
echo " - pubrel-interval: Delay in ms for the QoS 2 'Publish Release' handshake."
echo " - max-packets: Maximum number of MQTT control packets per session."
echo " - max-clients: Total concurrent IoT clients the engine will trap."
echo " "
echo " coap <port> <delay> <ack-timeout> <max-retransmit> <max-clients>"
echo " - port: The local port for the CoAP server emulator."
echo " - delay: Delay in ms between CoAP processing cycles."
echo " - ack-timeout: Initial timeout in ms before retransmitting a confirmable message."
echo " - max-retransmit: Maximum retransmission attempts for confirmable CoAP messages."
echo " - max-clients: Total concurrent IoT clients the engine will trap."

}

function invalidAmountOfArgs() {
Expand Down