From cd43518b117869223c61244166ca90d865c04c95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Mon, 15 Oct 2018 11:41:43 +0200 Subject: [PATCH] Add command line parameter documentation --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index ee925c5..a113944 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,39 @@ This daemon allows to set up the wireless network using a bluetooth LE connection. The daemon will automatically start a bluetooth low energy server if the system is currently not connected to any network. Once the system is connected, the daemon will shutdown the bluetooth server. +# Command line parameters + + $ nymea-network-manager --help + Usage:nymea-networkmanager [options] + + This daemon allows to configure a wifi network using a bluetooth low energy connection. + + Copyright © 2018 Simon Stürz + + Options: + -h, --help Displays this help. + -v, --version Displays version information. + -d, --debug Enable more debug output. + -a, --advertise-name The name of the bluetooth server. + Default "nymea". + -p, --platform-name The name of the platform this daemon + is running. Default "nymea-box". + -t, --timeout The timeout of the bluetooth server. + Minimum value is 10. Default "60". + -m, --mode Run the daemon in a specific mode. + Default "offline". + - offline: this mode starts the + bluetooth server once the device is + offline and not connected to any LAN + network. + - always: this mode enables the + bluetooth server as long the + application is running. + - start: this mode starts the bluetooth + server for 3 minutes on start and shuts + down after a connection. + + # Bluetooth GATT profile -------------------------------------------